Skip to content

Commit

Permalink
updated README.md and docs/tutorials.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
eacharles committed May 28, 2024
1 parent a4c4c71 commit 0b2248a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,29 @@ Quantile parametrization for probability distribution functions.
![Read the Docs](https://img.shields.io/readthedocs/qp)

## Motivation
This repository exists for two reasons.

1. To be the home of `qp`, a python package for handling probability distributions using various parametrizations, including a set of quantiles;
2. To help us learn best practices in software carpentry.
In a scientific inference we typically seek to characterize the posterior probability density function (PDF) for our parameter(s), which means we need to fund a suitable, calculable approximation to it. Popular choices include an ensemble of samples, a histogram estimator based on those samples, or (in 1 dimensional problems) a tabulation of the PDF on a regular parameter grid. qp is a python package that supports these approximations, as well as the “quantile parameterization” from which the package gets its name.

The [scipy.stats](https://docs.scipy.org/doc/scipy/reference/stats.html) package provides an interface to many probability distributions for parameterized analytic forms (e.g., Gaussians, LogNormal Distributions, etc...) `qp` extends that functionality to numerically-evaluated forms, such as the histograms and interpolated grids mentioned above.



## Examples

Here are some example notebooks to help new users explore `qp` functionality.

* **[Basic Demo](http://htmlpreview.github.io/?https://github.com/LSSTDESC/qp/blob/master/docs/demo.html)** [(raw notebook)](https://github.com/LSSTDESC/qp/blob/master/nb/demo.ipynb)

* **[Practical Example](http://htmlpreview.github.io/?https://github.com/LSSTDESC/qp/blob/master/docs/practical_example.html)** [(raw notebook)](https://github.com/LSSTDESC/qp/blob/master/nb/practical_example.ipynb)

Also: [Read the Docs](http://qp.readthedocs.io/)
* **[Using Metrics](http://htmlpreview.github.io/?https://github.com/LSSTDESC/qp/blob/master/docs/metrics_examples.html)** [(raw notebook)](https://github.com/LSSTDESC/qp/blob/master/nb/metrics_examples.ipynb)

* **[Using iterarors](http://htmlpreview.github.io/?https://github.com/LSSTDESC/qp/blob/master/docs/iterator_demo.html)** [(raw notebook)](https://github.com/LSSTDESC/qp/blob/master/nb/iterator_demo.ipynb)

* **[Quantile parameterization](http://htmlpreview.github.io/?https://github.com/LSSTDESC/qp/blob/master/docs/quantile_parameterization_demo.html)** [(raw notebook)](https://github.com/LSSTDESC/qp/blob/master/nb/quantile_parameterization_demo.ipynb)


Also the read the docs page has significantly more information: [Read the Docs](http://qp.readthedocs.io/)


## People
Expand Down
4 changes: 4 additions & 0 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@ See the following IPython Notebooks for some examples of using `qp`:

* `Basic Demo <http://htmlpreview.github.io/?https://github.com/LSSTDESC/qp/blob/docs/demo.html>`_
* `Practical Example <http://htmlpreview.github.io/?https://github.com/LSSTDESC/qp/blob/docs/practical_example.html>`_
* `Using Metrics <http://htmlpreview.github.io/?https://github.com/LSSTDESC/qp/blob/master/docs/metrics_examples.htm>`_
* `Using iterarors <http://htmlpreview.github.io/?https://github.com/LSSTDESC/qp/blob/master/docs/iterator_demo.html>`_
* `Quantile parameterization] <http://htmlpreview.github.io/?https://github.com/LSSTDESC/qp/blob/master/docs/quantile_parameterization_demo.html>`_

0 comments on commit 0b2248a

Please sign in to comment.