# dynesty¶

dynesty is a Pure Python, MIT-licensed Dynamic Nested Sampling package for estimating Bayesian posteriors and evidences. See Crash Course and Getting Started for more information. The latest development version can be found here.

The release paper describing the code can be found here.

As a multi-purpose sampler, dynesty is designed to perform “reasonably well” across a large array of problems but is not optimized for any single one. In particular, please take caution when applying dynesty to estimate Bayesian posteriors and evidences for large-dimensional (>30 dimensions or so) problems.

## Installation¶

dynesty is compatible with both Python 2.7 and Python 3.6. It requires numpy (for arithmetic), scipy (for special functions), matplotlib (for plotting), and six (to enforce Python 2/3 compliance). While not required, tqdm also allows for a nice progress bar.

Installing the most recent stable version of the package is as easy as:

pip install dynesty


Alternately, for users who might want newer development versions, it can also be installed directly from a local copy of the repository by running:

python setup.py install


## Citations¶

If you find dynesty useful in your research, a list of papers that you should cite can be generated directly from the sampler object by calling:

print(sampler.citations)


This will return a list of relevant papers and corresponding links to download citation information such as BibTex files. As an example:

import dynesty
sampler = dynesty.DynamicNestedSampler(loglike, prior_transform, ndim,
bound='balls', sample='rwalk')
print(sampler.citations)


Returns the following list of papers that should be cited:

Code and Methods:
================

Nested Sampling:
===============
Skilling (2006): projecteuclid.org/euclid.ba/1340370944

Dynamic Nested Sampling:
=======================
Higson et al. (2019): doi.org/10.1007/s11222-018-9844-0

Bounding Method:
===============

Sampling Method:
===============
Skilling (2006): projecteuclid.org/euclid.ba/1340370944


If you have utilized some of the error analysis features available through the provided utility functions (see Nested Sampling Errors), you should also cite Chopin & Robert (2010), Higson et al. (2018), and Speagle (2019).

See References and Acknowledgements for additional details.

## Changelog¶

### 1.1 (2021-04-05)¶

• Improved behavior and stability of the bounding distributions (with Sergey Koposov and Johannes Buchner).
• Added support for specifying the number of clustering dimensions ('ncdim') in case these may differ from the number of prior dimensions ('npdim') (with Colm Talbot).
• Fixed a bug where dynesty was not properly enforcing nested sampling’s monotonically-increasing likelihood condition when sampling (with Colm Talbot).
• Improved ability to save sampler objects to disk to backup progress (with Patrick Sheehan and Alex Nitz).
• Limited support for user-defined proposal strategies (with Gregory Ashton).

### 1.0.1 (2020-01-17)¶

• Small quality-of-life improvements to plotting.

### 1.0.0 (2019-09-22)¶

• Added support for period and reflective boundaries (with Gregory Ashton).
• Added support for interactive progress bar (with Daniel Foreman-Mackey).
• Added support for stopping criterion based on ESS (with Colm Talbot).
• Small bugfixes to code and documentation.
• Small quality-of-life improvements.

### 0.9.7 (2019-06-13)¶

• Ensemble bounds can now adapt to elongated distributions (with Johannes Buchner).
• Random walks now behave differently near boundaries (with Gregory Ashton).
• Pickling sampler states should now work better in Python 3 (with Dustin Lang.
• Doubled output errors in default approximation in line with theoretical expectations.
• Small bugfixes and docfixes (with Patricio Cubillos).

### 0.9.5 (2019-03-14)¶

• Added support for periodic boundary conditions.
• Set up basic tests for continuous integration.

### 0.9.4 (2019-03-07)¶

• Updated and reorganized documentation and demos.
• Changed defaults and added several “quality of life” improvements.

### 0.9.3 (2019-02-10)¶

• Updated documentation.
• Modified re-scaling behavior to better deal with inefficient proposals.
• Improved stability of the current ellipsoid decomposition algorithm.
• Added new 'auto' options and changed a number of defaults to make things easier for general users.
• Plotting now defaults to 95% credible intervals instead of 68%.

### 0.9.2 (2018-03-17)¶

• Added in a fast approximation option for jitter_run and simulate_run.
• Modified the default stopping heuristic. It now evaluates significantly faster but is a less accurate probe of the “true” KL divergence.
• Modified 'rwalk' behavior to better deal with edge cases.
• Changed defaults so performance should now be more stable (albiet slower) for the average user.
• Improved the stability of bounding ellipsoids.
• Fixed performance issues with 'rslice' and 'hslice'.
• Small plotting improvements.

### 0.9.1 (2018-03-01)¶

• Fixed a minor bootstrapping bug that affected performance for some users.
• Fixed a serious bug associated with the new singular decomposition algorithm and changed its behavior so it no longer auto-kills user runs when it fails.

### 0.9.0 (2018-02-25)¶

• dynesty is now on PyPI!

### 0.8.4 (2018-02-24)¶

• Added two new slice sampling options ('rslice' and 'hslice').
• Changed internals to allow user to access quantities during dynamic batch allocation. WARNING: Breaks some aspects of backwards compatibility for advanced users utilizing generators.
• Simplified parallelism options.
• Fixed a singular decomposition bug that occasionally appeared during runtime.
• Small plotting/utility improvements.

### 0.8.3 (2017-12-13)¶

• Fixed additional Python 2/3 compatibility bugs.
• Added the ability to pass user-specified custom print functions.
• Small improvements to plotting utilities.
• Small changes to improve user outputs and basic functionality.

### 0.8.2 (2017-09-15)¶

• Fixed map bugs that broke compatibility between Python 2 and 3.
• Fixed a bug where the sampler could break during the first update from the unit cube when using a pool.

### 0.8.1 (2017-09-12)¶

• Introduced a function wrapper for prior_transform and loglikelihood functions to allow users to pass args and kwargs.
• Fixed a small bug that could cause bounding ellipsoids to fail.
• Introduced a stability fix to the default weight_function when computing evidence-based weights.

### 0.8.0 (2017-09-08)¶

Initial beta release.