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.2
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.2.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: unimpeded-0.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 1a6d860d68de7f71b0227e7f4bbf3e6c962ccfa2ab269c9a22997a4a8a1fe990
MD5 b778eb71ae2f9b3d7fd2e1e7eb7ee614
BLAKE2b-256 c947ec983d68bc50ee73ac346434bdc647e2aff62f05e20252210da0a3e3b753

See more details on using hashes here.

File details

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

File metadata

  • Download URL: unimpeded-0.2.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d3191bfef216cc05a336f9da0b3ac542390afecd7ac7d9937c2bbd1e8ea61eda
MD5 2ba6b54374fb3813bb180ecfced0e6e9
BLAKE2b-256 e4e52a3a383d26fba01a5da61b74e68f8c362b61992243ff6774cd01ad2df060

See more details on using hashes here.

Supported by

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