Skip to main content

Universal model comparison & parameter estimation over diverse datasets

Project description

unimpeded:

Universal model comparison & parameter estimation distributed over every dataset

Author:

Will Handley

Version:
0.2.3
Homepage:

https://github.com/handley-lab/unimpeded

Documentation:

http://unimpeded.readthedocs.io/

Build Status Test Coverage Status Documentation Status PyPi location Permanent DOI for this release License information

unimpeded

It can be viewed as an extension to the Planck legacy archive across models and datasets

It provides mcmc and nested sampling chains, allowing parameter estimation, model comparison and tension quantification.

Current functionality includes:

UNDER CONSTRUCTION

Features

Installation

unimpeded can be installed via pip

pip install unimpeded

or via the setup.py

git clone https://github.com/handley-lab/unimpeded
cd unimpeded
python -m pip install .

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

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

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:

python -m pip install ".[all,docs]"
cd docs
make html

and view the documentation by opening docs/build/html/index.html in a browser. To regenerate the automatic RST files run:

sphinx-apidoc -fM -t docs/templates/ -o docs/source/ unimpeded/

Citation

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

Handley, (2023) unimpeded: cosmological inference across models and datasets.

or using the BibTeX:

@article{unimpeded,
    year  = {2023},
    author = {Will Handley},
    title = {unimpeded: cosmological inference across models and datasets},
    journal = {In preparation}
}

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.

  • Adding models and data to the grid. Contact Will Handley to request models or ask for your own to be uploaded.

Questions/Comments

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

unimpeded-0.2.3.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

unimpeded-0.2.3-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file unimpeded-0.2.3.tar.gz.

File metadata

  • Download URL: unimpeded-0.2.3.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for unimpeded-0.2.3.tar.gz
Algorithm Hash digest
SHA256 382949fdf06d96d345f1730c70a4270e0a851876041d33b197cc94338c62a576
MD5 e3a0ae60c6af02d48b6b3ece249c90b1
BLAKE2b-256 8d04318631886c22c8933488ca37854e05c54cf4e76f481bc99b52d58c795c1c

See more details on using hashes here.

File details

Details for the file unimpeded-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: unimpeded-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for unimpeded-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c8aa5b24cf7c068fa25491024f090baec8a7975839d4e7b27da351d0ea5aca71
MD5 7b88f1f532bc8f2bdc15da87e6cb0f58
BLAKE2b-256 f9b1d737a44cef0017939401d0f1438cede68aa3afa2a5ceee28b53718231b45

See more details on using hashes here.

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