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.0.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.0.3.tar.gz (4.3 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.0.3-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: unimpeded-0.0.3.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for unimpeded-0.0.3.tar.gz
Algorithm Hash digest
SHA256 a4505da236b5c9510f47d7314897e692af3323f407334b404126f87cedc0269a
MD5 489fa0ac642559ecc035049657a6424c
BLAKE2b-256 7ae0033ccd290f6d0e5405c00cdd66a82d0c9f4de3757c39711850cf714c7c2d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for unimpeded-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6520edccc495c482e03b76c709c0bd538ce940b160c843853d961bcb097bb901
MD5 791bbc59f7103c8cfee23e45d659a19a
BLAKE2b-256 46157ff52996926246548c6340c510970270696412ea632210c4bb77b9ea84cf

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