Metadata-Version: 2.1
Name: spaemis
Version: 0.2.1
Summary: Produce a coherent set of emissions for regional air quality modelling
Home-page: https://github.com/climate-resource/spaemis
Keywords: emissions,climate,air quality
Author: Jared Lewis
Author-email: jared.lewis@climate-resource.com
Requires-Python: >=3.10,<3.12
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Provides-Extra: notebooks
Requires-Dist: cattrs (>=22.2.0,<23.0.0)
Requires-Dist: geopandas (>=0.13.0,<0.14.0)
Requires-Dist: jupytext (==1.14.5) ; extra == "notebooks"
Requires-Dist: matplotlib (>=3.7.1,<4.0.0) ; extra == "notebooks"
Requires-Dist: netcdf4 (>=1.6.3,<2.0.0)
Requires-Dist: notebook (>=6.5.3,<7.0.0) ; extra == "notebooks"
Requires-Dist: papermill ; extra == "notebooks"
Requires-Dist: pooch (>=1.7.0,<2.0.0)
Requires-Dist: python-dotenv ; extra == "notebooks"
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: rioxarray (>=0.14.1,<0.15.0)
Requires-Dist: scipy (>=1.10.1,<2.0.0)
Requires-Dist: scmdata (>=0.15.0,<0.16.0)
Requires-Dist: seaborn ; extra == "notebooks"
Requires-Dist: typing-extensions (>=4.5.0,<5.0.0)
Requires-Dist: xarray (>=2023.5.0,<2024.0.0)
Description-Content-Type: text/markdown

# SpaEmis

<!--- sec-begin-description -->

Produce a coherent set of emissions for regional air quality modelling


This model is a work in progress and is under active development. This work was undertaken
by `Climate Resource <https://www.climate-resource.com>`_ and funded by `CSIRO <https://www.csiro.au/en/>`_
<!--- sec-end-description -->

## Installation

<!--- sec-begin-installation -->

Spaemis can be installed with pip:

```bash
pip install spaemis
```

Additional dependencies can be installed using

```bash
# To add plotting dependencies
pip install spaemis[plots]
# To add notebook dependencies
pip install spaemis[notebooks]
```

A set of `Input4MIPs <https://esgf-node.llnl.gov/projects/input4mips/>`_ emissions data
is also required as it is a common proxy.

<!--- sec-end-installation -->

<!--- sec-begin-installation-dev -->

### For developers

For development, we rely on [poetry](https://python-poetry.org) for all our
dependency management. To get started, you will need to make sure that poetry
is installed
(https://python-poetry.org/docs/#installing-with-the-official-installer, we
found that pipx and pip worked better to install on a Mac).

For all of work, we use our `Makefile`.
You can read the instructions out and run the commands by hand if you wish,
but we generally discourage this because it can be error prone.
In order to create your environment, run `make virtual-environment`.

If there are any issues, the messages from the `Makefile` should guide you
through. If not, please raise an issue in the [issue tracker][issue tracker].

<!--- sec-end-installation-dev -->

<!--- sec-begin-links -->

[issue tracker]: https://github.com/climate-resource/spaemis/issues

<!--- sec-end-links -->

