Installation#

Released versions of punx are available on Conda Forge and PyPI. The source code is available on GitHub.

1conda install punx -c conda-forge

1pip install punx

The source code of punx, including the latest development versions, can be downloaded from the GitHub repository:

cd /some/directory
git clone https://github.com/prjemian/punx.git
cd punx
pip install -e .

Updating#

If you have installed previously, as above, choose one of these that corresponds with your installation:

$ conda update punx -c conda-forge
$ pip install -U --no-deps punx
$ git pull  # (in the cloned directory)

Required Packages#

It may be necessary to install some prerequisite packages in your python installation. If you are using an Anaconda python distribution, it is advised to install these pre-requisites using conda rather than pip. The pre-requisites include:

h5py
lxml
numpy
Qt and PyQt (v5)
requests

See your distribution’s documentation for how to install these. With Anaconda, use:

conda install h5py lxml numpy Qt=5 PyQt=5 requests pyRestTable -c conda-forge

Package	URL
h5py	https://www.h5py.org
lxml	https://lxml.de
numpy	https://numpy.scipy.org
PyQt5	https://www.riverbankcomputing.com/software/pyqt/
requests	https://docs.python-requests.org

Optional Packages#

Package	URL
pyRestTable	https://pyresttable.readthedocs.io

The pyRestTable package is used for various reports in the punx application.: If using the punx package as a library and developing your own custom reporting, this package is not required.