Installation

Install PESummary

PESummary is developed and tested for python 3.5+. We recommend that this code is installed inside a virtual environment using virtualenv. This environment can be installed with python 3.5+ using pyenv.

For detailed instructions on how to set up your virtual environment, please refer to setting up a virtual environment.

Installing PESummary using pip

If you choose to install PESummary using pip, then simply run:

$ source ~/virtualenvs/pesummary_py3.6/bin/activate
$ pip install pesummary

Installing PESummary using conda

If you choose to install PESummary using conda, then simply run:

$ source ~/virtualenvs/pesummary_pyenv3.6/bin/activate
$ conda install -c conda-forge pesummary

Pulling the PESummary docker image

If you would like, you are able to pull the PESummary docker image. To do this, simply run:

$ docker pull 08hoyc/pesummary

Installing PESummary from source

If you would like to install PESummary from source, then please make sure that you set up your virtual environment correctly using either the instructions highlighted abov or using your own techniques, you have a working version of pip and you have git correctly installed.

First clone the repository, then install all requirements, then install the software,

$ source ~/virtualenvs/pesummary_pyenv3.6/bin/activate
$ git clone git@git.ligo.org:lscsoft/pesummary.git
$ cd pesummary/
$ pip install -r requirements.txt
$ python setup.py install

Installing optional requirements

The requirements.txt file contains all the necessary packages for running PESummary. In addition we provide additional packages for running the tests and creating these docs. To install these optional_requirements, please install using,

$ source ~/virtualenvs/pesummary_pyenv3.6/bin/activate
$ pip install -r optional_requirements.txt

Identifying the version number of your installation

We recommend that you always keep up to date with new releases. If you would like to know what version of PESummary you are running, you can either find out in a python shell,

$ python -c "import pesummary; print(pesummary.__version__)"
0.12.0+10.gad51a48.dirty

or using the summaryversion executable,

$ summaryversion
0.12.0+10.gad51a48.dirty