pyhetdex

pyhetdex is a python library designed to collect code can could be used by different project like VIRUS Data Analysis Tool, VIRUS Health Check, simhetdex or Cure-WISE.

Official documentation

The official documentation can be found online.

We use the Redmine issue tracker to register bugs, feature requests and other issues.

Installation

The recommended way to install pyhetdex is using pip:

pip install --extra-index-url https://gate.mpe.mpg.de/pypi/simple/ pyhetdex

It's possible to set the extra index URL permanently by adding the following lines to the $HOME/.pip/pip.conf file:

[global]
extra-index-url = https://gate.mpe.mpg.de/pypi/simple

or exporting the environment variable:

export PIP_EXTRA_INDEX_URL=https://gate.mpe.mpg.de/pypi/simple

The list of released versions can be seen on the MPE pypi server. A specific version can be installed using specifiers, e.g. issuing pip install pyhetdex==0.5.

pip will take care of installing all the pyhetdex dependences

We suggest you install pyhetdex into a virtualenv, in an anaconda/conda or in similar environments.

Of course it is also possible to install pyhetdex without any of the above with::

pip install --user --extra-index-url https://gate.mpe.mpg.de/pypi/simple/ pyhetdex

This way the pyhetdex executables are installed in $HOME/.local/bin, so make sure to add this to the environment variable PATH to be able to easily use them on the command line. The use of sudo when installing with pip is discouraged and potentially harmful.

Dependencies

Mandatory

six
numpy
matplotlib
scipy
astropy>=1
Pillow

Optional:

test: pytest-cov
      pytest-xdist
      pytest-catchlog
      pytest
      tox
documentation: sphinx
               numpydoc
               alabaster

Development

If you want to help developing pyhetdex, please follow the information about installation and contribution and get in touch with the other developers.

Notes

Please use markdown syntax so it can be easily converted to html or wiki format if needed and remains very readable