Metadata-Version: 2.1
Name: unimpeded
Version: 0.1.1
Summary: Universal model comparison & parameter estimation over diverse datasets
Author-email: Will Handley <williamjameshandley@gmail.com>
License: MIT License
        
        Copyright (c) 2023 Will Handley
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/handley-lab/unimpeded
Project-URL: Bug Tracker, https://github.com/handley-lab/unimpeded/issues
Project-URL: Documentation, https://unimpeded.readthedocs.io/en/latest/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Provides-Extra: docs
Provides-Extra: test
License-File: LICENSE

===========================================================================================
unimpeded: Universal model comparison & parameter estimation distributed over every dataset
===========================================================================================
:unimpeded: Universal model comparison & parameter estimation distributed over every dataset 
:Author: Will Handley
:Version: 0.1.1
:Homepage: https://github.com/handley-lab/unimpeded
:Documentation: http://unimpeded.readthedocs.io/

.. image:: https://github.com/handley-lab/unimpeded/workflows/CI/badge.svg?branch=master
   :target: https://github.com/handley-lab/unimpeded/actions?query=workflow%3ACI+branch%3Amaster
   :alt: Build Status
.. image:: https://codecov.io/gh/handley-lab/unimpeded/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/handley-lab/unimpeded
   :alt: Test Coverage Status
.. image:: https://readthedocs.org/projects/unimpeded/badge/?version=latest
   :target: https://unimpeded.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status
.. image:: https://badge.fury.io/py/unimpeded.svg
   :target: https://badge.fury.io/py/unimpeded
   :alt: PyPi location
.. image:: https://zenodo.org/badge/532924237.svg
   :target: https://zenodo.org/badge/latestdoi/532924237
   :alt: Permanent DOI for this release
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
   :target: https://github.com/handley-lab/unimpeded/blob/master/LICENSE
   :alt: 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

.. code:: bash

    pip install unimpeded

or via the setup.py

.. code:: bash

    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:

.. code:: bash

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


Dependencies
~~~~~~~~~~~~

Basic requirements:

- Python 3.6+
- `anesthetic <https://pypi.org/project/anesthetic/>`__

Documentation:

- `sphinx <https://pypi.org/project/Sphinx/>`__
- `numpydoc <https://pypi.org/project/numpydoc/>`__

Tests:

- `pytest <https://pypi.org/project/pytest/>`__

Documentation
-------------

Full Documentation is hosted at `ReadTheDocs <http://unimpeded.readthedocs.io/>`__.  To build your own local copy of the documentation you'll need to install `sphinx <https://pypi.org/project/Sphinx/>`__. You can then run:

.. code:: bash

    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:

.. code:: bash

    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:

.. code:: 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 <https://github.com/handley-lab/unimpeded>`__.

- You can `open an issue <https://github.com/handley-lab/unimpeded/issues>`__ 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 <mailto:wh260@cam.ac.uk>`__ to request models or ask for your own to be uploaded.


Questions/Comments
------------------
