Installation

Requirements

PSTools depends on several python libraries, e.g. healpy, matplotlib, astropy, etc. If you use setup installation, pip would install them automatically so you do not need to install them yourself. If you adopt pip approach, you need to do: pip install healpy –user, all the libraries that needed by PSTools can be installed via pip. If you prefer bash to the setup, astrocond is suggested, and then you need to install a few libraries if needed.

As an option, PSTools employ pygcn to listens for VOEvent XML format notices over the custom TCP/IP VOEvent Transport Protocol, Thus, if you intend to activate such function, please verify your machine has network, which is not private.

Note that only Linux and MAC OS have been tested, for Windows everything reamins unknown. Considering the Python version, the tool is working for Python 2/3.

Bash installation (RECOMMENDED)

You can download the source files from pstools repository with the git command:

git clone https://github.com/saberyoung/pstools.git

which would create one directory appear in the current path, e.g. /home/xxx/pstools/. Then, you need to add one line in your bash (if you use bash):

alias pstools_init="source /home/xxx/pstools/pst.bash"

After you source your bash file, you can then initial pstools by:

source activate iraf27/astroconda
pstools_init

This approach would not install the pipeline, but instead call python via envirnmental defination, which is light and easy.

Source installation with Pip

It is possible to build the latest pstools with pip

pip install --user pstools

If you have installed with pip, you can keep your installation up to date by upgrading from time to time:

pip install --user --upgrade pstools

Almost-as-quick installation from official source release

PSTools is also available in the Python Package Index (PyPI). You can download it with:

curl -O https://files.pythonhosted.org/packages/1c/d5/42cb34cd80b1049b2f4352f17e9277344a25ee07edc8557d9abf9e963147/pstools-0.0.3.tar.gz

and build it with:

tar -xzf pstools-0.0.3.tar.gz
python setup.py install --user

If everything goes fine, you can test it:

python

>>> import pst
>>> pst.__version__

Clean

When you run “python setup.py”, temporary build products are placed in the “build” directory. If you want to clean out and remove the build directory, then run:

python setup.py clean --all

Check

PSTools would provide two excutable command, i.e. pstools/slack, if you installed it correctly. To check if they’re working:

pstools:

pstools -h

slack:

after a proper setup process, go and type sth in the specific slack channel by mentioning the slack bot, e.g. @gwhelp status. If there’re sth return in slack chat, it’s alive, and you can then follow its instructions.