Metadata-Version: 2.4
Name: curepy
Version: 0.1.5
Summary: Comet Uncertainties for Retrievals in PYthon
Author-email: Joe Riordan <joe.riordan@npl.co.uk>, Pieter De Vis <pieter.de.vis@npl.co.uk>
License: None
Project-URL: Homepage, https://gitlab.npl.co.uk/eco/tools/curepy
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: emcee
Requires-Dist: comet_maths
Requires-Dist: punpy
Requires-Dist: tqdm
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx_design; extra == "dev"
Requires-Dist: sphinx_book_theme; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Requires-Dist: ipython; extra == "dev"
Requires-Dist: sphinx_autosummary_accessors; extra == "dev"
Requires-Dist: pytest-html; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file

# curepy

Comet Uncertainties for REtrievals in PYthon

## Beta Version

**WARNING:** This software is a beta version, results should be used with caution. Please share any feedback you have after using the tool.

## Usage

### Virtual environment

It's always recommended to make a virtual environment for each of your python projects. Use your preferred virtual environment manager if you want and activate it for the rest of these commands. If you're unfamiliar, read https://realpython.com/python-virtual-environments-a-primer/. You can set one up using:

```bash
python -m venv venv
```

and then activate it on Windows by using `venv/Scripts/activate`.

### Installation

Install your package and its dependancies by using:

```bash
pip install -e .
```

### Development

For developing the package, you'll want to install the pre-commit hooks as well. Type:

```bash
pre-commit install
```

Note that from now on when you commit, `black` will check your code for styling errors. If it finds any it will correct them, but the commit will be aborted. This is so that you can check its work before you continue. If you're happy, just commit again.

### Compatibility

## Licence

## Authors

`curepy` was written by [Joe Riordan](mailto:joe.riordan@npl.co.uk) and [Pieter De Vis](mailto:pieter.de.vis@npl.co.uk).
