# 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 -->
Raw data
{
"_id": null,
"home_page": "https://github.com/climate-resource/spaemis",
"name": "spaemis",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<3.12",
"maintainer_email": "",
"keywords": "emissions,climate,air quality",
"author": "Jared Lewis",
"author_email": "jared.lewis@climate-resource.com",
"download_url": "https://files.pythonhosted.org/packages/92/97/702fc3c780833d555335361a2400f9f54256e65c9a8b4a5a3b0473dea01b/spaemis-0.2.3.tar.gz",
"platform": null,
"description": "# SpaEmis\n\n<!--- sec-begin-description -->\n\nProduce a coherent set of emissions for regional air quality modelling\n\n\nThis model is a work in progress and is under active development. This work was undertaken\nby `Climate Resource <https://www.climate-resource.com>`_ and funded by `CSIRO <https://www.csiro.au/en/>`_\n<!--- sec-end-description -->\n\n## Installation\n\n<!--- sec-begin-installation -->\n\nSpaemis can be installed with pip:\n\n```bash\npip install spaemis\n```\n\nAdditional dependencies can be installed using\n\n```bash\n# To add plotting dependencies\npip install spaemis[plots]\n# To add notebook dependencies\npip install spaemis[notebooks]\n```\n\nA set of `Input4MIPs <https://esgf-node.llnl.gov/projects/input4mips/>`_ emissions data\nis also required as it is a common proxy.\n\n<!--- sec-end-installation -->\n\n<!--- sec-begin-installation-dev -->\n\n### For developers\n\nFor development, we rely on [poetry](https://python-poetry.org) for all our\ndependency management. To get started, you will need to make sure that poetry\nis installed\n(https://python-poetry.org/docs/#installing-with-the-official-installer, we\nfound that pipx and pip worked better to install on a Mac).\n\nFor all of work, we use our `Makefile`.\nYou can read the instructions out and run the commands by hand if you wish,\nbut we generally discourage this because it can be error prone.\nIn order to create your environment, run `make virtual-environment`.\n\nIf there are any issues, the messages from the `Makefile` should guide you\nthrough. If not, please raise an issue in the [issue tracker][issue tracker].\n\n<!--- sec-end-installation-dev -->\n\n<!--- sec-begin-links -->\n\n[issue tracker]: https://github.com/climate-resource/spaemis/issues\n\n<!--- sec-end-links -->\n",
"bugtrack_url": null,
"license": "",
"summary": "Produce a coherent set of emissions for regional air quality modelling",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/climate-resource/spaemis"
},
"split_keywords": [
"emissions",
"climate",
"air quality"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c94e0c884e6f44163aefad49f4fedb985ff90575149011334c03f3a1366695d8",
"md5": "4be11db2702168e0ba763cf16c435ab1",
"sha256": "8fae24c0353e8234cdd0bdc07a3d0f6373661082daa83c0e5bbcef6710071e83"
},
"downloads": -1,
"filename": "spaemis-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4be11db2702168e0ba763cf16c435ab1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<3.12",
"size": 36776,
"upload_time": "2023-05-29T13:31:01",
"upload_time_iso_8601": "2023-05-29T13:31:01.514228Z",
"url": "https://files.pythonhosted.org/packages/c9/4e/0c884e6f44163aefad49f4fedb985ff90575149011334c03f3a1366695d8/spaemis-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9297702fc3c780833d555335361a2400f9f54256e65c9a8b4a5a3b0473dea01b",
"md5": "a702d1e7b849fe73c4feb1200e52f2ea",
"sha256": "a729620c0791c20bb46a072c6a3a730e7fc8fce4068a37ba20d9efcf17913e17"
},
"downloads": -1,
"filename": "spaemis-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "a702d1e7b849fe73c4feb1200e52f2ea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<3.12",
"size": 29005,
"upload_time": "2023-05-29T13:31:03",
"upload_time_iso_8601": "2023-05-29T13:31:03.142654Z",
"url": "https://files.pythonhosted.org/packages/92/97/702fc3c780833d555335361a2400f9f54256e65c9a8b4a5a3b0473dea01b/spaemis-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-29 13:31:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "climate-resource",
"github_project": "spaemis",
"github_not_found": true,
"lcname": "spaemis"
}
JSON
