Skip to main content

Models for nessai

Project description

DOI PyPI Integration tests Unit tests

nessai-models

Models for use with the nested sampling package nessai.

Included models

  • n-dimensional unit Gaussian
  • n-dimensional HalfGaussian
  • n-dimensional Rosenbrock
  • n-dimensional mixture of Gaussians
  • n-dimensional slab plus spike model
  • Gaussian mixture using data to based on this example from cpnest
  • n-dimensional Egg Box based on the version in Feroz et al. 2008
  • n-dimensional Pyramid-like model
  • n-dimensional Brewer likelihood (Skilling's "Staistical Model") from Brewer et al.
  • Linear signal plus Gaussian noise model (LinearSignal)
  • Sinusoidal signal plus Gaussian noise model (SinusoidalSignal)
  • Mixture of 1-dimensional distributions (MixtureOfDistributions)

Requirements

nessai_models requires:

  • numpy
  • scipy
  • nessai>=0.6.0

Installation

We recommend following the installation instructions for nessai and then installing nessai_models since it shares all of its dependencies with nessai.

nessai_models can be install from PyPI using

pip install nessai-models

Example usage

Below is an example of using nessai_models so configure a 4-dimensional Gaussian and then sample it using nessai.

from nessai import FlowSampler
from nessai_models import Gaussian

model = Gaussian(4)
fs = FlowSampler(model, output='example/')
fs.run()

Citing

If you use nessai_models in your work please cite the Zenodo DOI

Project details


Download files

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

Source Distribution

nessai-models-0.5.0.tar.gz (18.1 kB view hashes)

Uploaded Source

Built Distribution

nessai_models-0.5.0-py3-none-any.whl (14.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page