Skip to main content

anesthetic: nested sampling visualisation

Project description

anesthetic:nested sampling visualisation
Author: Will Handley
Version: 1.2.1
Homepage:https://github.com/williamjameshandley/anesthetic
Documentation:http://anesthetic.readthedocs.io/
Build Status https://circleci.com/gh/williamjameshandley/anesthetic.svg?style=svg Test Coverage Status Documentation Status PyPi location Permanent DOI for this release Review Status License information Online interactive notebook

anesthetic brings together tools for processing nested sampling chains, leveraging standard scientific python libraries.

You can see example usage and plots in the plot gallery, or in the corresponding Jupyter notebook.

Current functionality includes:

  • Computation of Bayesian evidences, Kullback-Liebler divergences and Bayesian model dimensionalities.
  • Marginalised 1d and 2d plots.
  • Dynamic replaying of nested sampling.

This tool was designed primarily for use with nested sampling outputs, although it can be used for normal MCMC chains.

For an interactive view of a nested sampling run, you can use the anesthetic script.

$ anesthetic <ns file root>
https://github.com/williamjameshandley/anesthetic/raw/master/images/anim_1.gif

Features

  • Both samples and plotting axes are stored as a pandas.DataFrame, with parameter names as indices, which makes for easy access and modification.
  • Sensible color scheme for plotting nearly flat distributions.
  • For easy extension/modification, uses the standard python libraries: numpy, scipy, matplotlib and pandas.

Installation

anesthetic can be installed via pip

pip install anesthetic

or via the setup.py

git clone https://github.com/williamjameshandley/anesthetic
cd anesthetic
python setup.py install --user

You can check that things are working by running the test suite:

export MPLBACKEND=Agg     # only necessary for OSX users
python -m pytest
flake8 anesthetic tests
pydocstyle --convention=numpy anesthetic

Dependencies

Basic requirements:

Documentation:

Tests:

Documentation

Full Documentation is hosted at ReadTheDocs. To build your own local copy of the documentation you’ll need to install sphinx. You can then run:

cd docs
make html

Citation

If you use anesthetic to generate plots for a publication, please cite as:

Handley, (2019). anesthetic: nested sampling visualisation. Journal of Open
Source Software, 4(37), 1414, https://doi.org/10.21105/joss.01414

or using the BibTeX:

@article{anesthetic,
    doi = {10.21105/joss.01414},
    url = {http://dx.doi.org/10.21105/joss.01414},
    year  = {2019},
    month = {Jun},
    publisher = {The Open Journal},
    volume = {4},
    number = {37},
    pages = {1414},
    author = {Will Handley},
    title = {anesthetic: nested sampling visualisation},
    journal = {The Journal of Open Source Software}
}

Contributing

There are many ways you can contribute via the GitHub repository.

  • You can open an issue to report bugs or to propose new features.
  • Pull requests are very welcome. Note that if you are going to propose major changes, be sure to open an issue for discussion first, to make sure that your PR will be accepted before you spend effort coding it.

Questions/Comments

Another posterior plotting tool?

This is my posterior plotter. There are many like it, but this one is mine.

There are several excellent tools for plotting marginalised posteriors:

Why create another one? In general, any dedicated user of software will find that there is some functionality that in their use case is lacking, and the designs of previous codes make such extensions challenging. In my case this was:

  1. For large numbers of samples, kernel density estimation is slow, or inaccurate (particularly for samples generated from nested sampling). There are kernel density estimators, such as fastKDE, which ameliorate many of these difficulties.
  2. Existing tools can make it difficult to define new parameters. For example, the default cosmomc chain defines omegabh2, but not omegab. The transformation is easy, since omegab = omegabh2/ (H0/100)**2, but implementing this transformation in existing packages is not so trivial. anesthetic solves this issue by storing the samples as a pandas array, for which the relevant code for defining the above new parameter would be
from anesthetic import MCMCSamples
samples = MCMCSamples(root=file_root)                         # Load the samples
samples['omegab'] = samples.omegabh2/(samples.H0/100)**2      # Define omegab
samples.tex['omegab'] = '$\Omega_b$'                          # Label omegab
samples.plot_1d('omegab')                                     # Simple 1D plot
  1. Many KDE plotting tools have conventions that don’t play well with uniformly distributed parameters, which presents a problem if you are trying to plot priors along with your posteriors. anesthetic has a sensible mechanism, by defining the contours by the amount of iso-probability mass they contain, but colouring the fill in relation to the probability density of the contour.

What’s in a name?

There is an emerging convention for naming nested sampling packages with words that have nest in them (nestle and dynesty, nestorflow). Doing a UNIX grep:

grep nest /usr/share/dict/words

yields a lot of superlatives (e.g. greenest), but a few other cool names for future projects:

  • amnesty
  • defenestrate
  • dishonestly
  • inestimable
  • minestrone
  • rhinestone

I chose anesthetic because I liked the soft ‘th’, and in spite of the US spelling.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for anesthetic, version 1.2.1
Filename, size File type Python version Upload date Hashes
Filename, size anesthetic-1.2.1.tar.gz (32.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page