unimpeded 0.2.3

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

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