Metadata-Version: 2.4
Name: siem
Version: 0.0.1
Summary: A package to build WRF-Chem and CMAQ emission files
Author: Mario Gavidia-Calderón
Author-email: mario.calderon@iag.usp.br
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: xarray
Requires-Dist: pyproj
Requires-Dist: osmnx
Requires-Dist: pseudonetcdf
Requires-Dist: geopandas
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# siem: SImplified Emission Model

This is the SImplified Emission Model.
It is a python package to create the emission
file for [WRF-Chem](https://www2.acom.ucar.edu/wrf-chem) and [CMAQ](https://www.epa.gov/cmaq) air quality models.

It is inspired on the work of [Andrade et al. (2015)](http://journal.frontiersin.org/Article/10.3389/fenvs.2015.00009/abstract),
[AAS4WRF](https://github.com/alvv1986/AAS4WRF), and [PyChEmiss](https://github.com/quishqa/PyChEmiss).

`siem` main objective is to create the emission file for cities with scarce emission data.

## Installation

1. Clone this repository:

```
git clone git@github.com:quishqa/siem.git
```

2. Enter the main folder and create the `siem` environment by using:

```
conda env create -f environment.yml

```

3. Finally, install `siem` by using:

```
pip install -e .
```

## How to use

`siem` has three classes: `EmissionSource`, `PointSource`, and `GroupSources`.

- `EmissionSource`: It is used to calculate and distribute emissions by using a spatial proxy.
- `PointSource`: It is used to distribute point emissions from a table.
- `GroupSources`: It is used to merge `EmissionSource` objects and `PointSource` objects into a single object. Useful to create the final emission file.

Each of these objects has the methods `to_wrfchem` and `to_cmaq` that allow us to create the emission file for WRF-Chem and CMAQ respectively.

You can check the documentation for further details:

- [Tutorials](https://quishqa.github.io/siem/tutorials/)
- [How to guide](https://quishqa.github.io/siem/how-to-guides/)
- Or you can check the `scripts` folder for examples.

## Acknoledgements

We thanks [IAG/USP](https://www.iag.usp.br/), [LAPAT](http://www.lapat.iag.usp.br/) and [MASTER](http://www.master.iag.usp.br/) labs!
