qp

qp is a python library for the storage and manipulation of tables of probability distributions.

Features

• Read and write tables of probability distributions to/from file
• Parameterize probability distributions inferred from real data
• Convert between different methods of parameterizing probability distributions
• Perform statistical methods on many distributions at a time

Links

• Read the Docs
• PyPI

Installation

For a basic install of qp:

git clone https://github.com/LSSTDESC/qp.git
cd qp
pip install .

To install the developer environment:

# Clone the repo and enter it
git clone https://github.com/LSSTDESC/qp.git
cd qp

# Creating the environment from the YAML
conda env create -n qp_dev -f environment.yml

# Activate the environment
conda activate qp_dev

# Install qp in editable mode with dev dependencies
pip install -e '.[dev]'

For more details see the installation instructions on Read the Docs.

Building the documentation locally

To build the documentation locally, start by making sure that you have the appropriate documentation packages installed:

pip install -e '.[docs]'

Once you have the appropriate packages, run the following lines of code to make the documentation:

cd docs/
make html

The HTML files will be generated in the _build/ folder inside the docs/ folder.

People

See the contributors page for an up-to-date list of the major contributors. Some of the main contributors are listed here:

• Alex Malz
• Phil Marshall
• Eric Charles
• Sam Schmidt

Citation

If you end up using any of the code or ideas you find here in your academic research, please cite our paper: A. I. Malz et al 2018 AJ 156 35 (ADS - BibTex).

Contribution

If you are interested in this project, please write us an issue. Before contributing to the qp project, take a look at the Contribution Guidelines.

License

The code in this repo is available for re-use under the MIT license (see the license file).