API

Full API documentation on one page

The main interface is ultranest.integrator.ReactiveNestedSampler, also available as ultranest.ReactiveNestedSampler.

Modules commonly used directly:

• ultranest.integrator: Nested sampling integrators

• ultranest.plot: Plotting utilities

• ultranest.stepsampler: MCMC-like step sampling

• ultranest.popstepsampler: Vectorized step samplers

• ultranest.calibrator: Calibration of step sampler

• ultranest.solvecompat: Drop-in replacement for pymultinest.solve.

• ultranest.hotstart: Warm start

Internally used modules:

• ultranest.mlfriends: Region construction methods

• ultranest.netiter: Graph-based nested sampling

• ultranest.ordertest: U test for a uniform distribution of integers

• ultranest.stepfuncs: Efficient helper functions for vectorized step-samplers

• ultranest.store: Storage for nested sampling points

• ultranest.viz: Live point visualisations

Experimental modules, no guarantees:

• ultranest.dychmc: Constrained Hamiltanean Monte Carlo step sampling.

• ultranest.dyhmc: Experimental constrained Hamiltanean Monte Carlo step sampling

• ultranest.flatnuts: FLATNUTS is a implementation of No-U-turn sampler

• ultranest.pathsampler: MCMC-like step sampling on a trajectory.

• ultranest.samplingpath: Sparsely sampled, virtual sampling path.

Alphabetical list of submodules

• ultranest package
  • Submodules
  • ultranest.calibrator module
  • ultranest.dychmc module
  • ultranest.dyhmc module
  • ultranest.flatnuts module
  • ultranest.hotstart module
  • ultranest.integrator module
  • ultranest.mlfriends module
  • ultranest.netiter module
  • ultranest.ordertest module
  • ultranest.pathsampler module
  • ultranest.plot module
  • ultranest.popstepsampler module
  • ultranest.samplingpath module
  • ultranest.solvecompat module
  • ultranest.stepfuncs module
  • ultranest.stepsampler module
  • ultranest.store module
  • ultranest.utils module
  • ultranest.viz module
  • Module contents