unox
Use machine learning to make predictions of NOₓ and other atmospheric species.
This is an application of the U-net deep learning model for North American NOₓ emission estimates using the tensorflow Python package.
Documentation
Setup guides, example usage, and API reference are available on Read the Docs.
Installation
This package is not currently available for installation with pip.
See the installation guide for instructions on how to get set up developing the code.
Requirements
There are two different sets of requirements, one for the analysis / plotting environment and one for the GPU environment.
For the analysis / plotting environment, dependencies are tracked using the poetry dependency manager and the current specified version dependencies are listed under [tool.poetry.dependencies] in the pyproject.toml file.
For the GPU environment, a summary of the requirements is given in the table below:
| Package | Version |
|---|---|
| Python | 3.12.4 |
| Xarray | 2024.3.0 |
| NetCDF4 | 1.7.2 |
| TensorFlow | 2.17.0 |
| Keras | 3.10.0 |
| CUDA | 12.6 |
Contributing
Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.
License
The unox package was created by Mikhail Schee. It is licensed under the terms of the MIT license.
Credits
- The U-net model is based on Tailong He's repository for Chinese NOₓ emissions1.
- Initial transition from China region to North America by Evelyn MacDonald.
- Initial adaptation to make estimates for CO by Daniel Sequeira.
- Documentation, converting
.npyto.ncfiles, and ensemble runs by Mikhail Schee. - The
unoxpackage was based off thepy-pkgs-cookiecuttertemplate usingcookiecutter. - Package structure, documentation, and continuous integration based on the Python Packages open source book by Tomas Beuzen & Tiffany Timbers
Source of data
- Training stage 1 involves TCR-2 surface NO$_2$ concentrations and NOₓ emissions. Both could be found from the JPL TCR-2 website. Last access was on 12 March 2025.
- Training stage 2 involves in situ daily NO$_2$ measurements from the United States Environmental Protection Agency (EPA). Canadian data is planned to be added in the future.
- Both stages require meteorological fields from ERA5 on single levels and on pressure levels.
- Scripts for downloading ERA5 data and creating Unet input files and more information about the input file format are in the
datafiles/directory. Data are currently stored on animus-c.
-
He, T.-L.; Jones, D. B. A.; Miyazaki, K; Bowman, K. W.; Jiang, Z.; Chen, X; Li, R.; Zhang, Y; Li, K, (2022) "Inverse modeling of Chinese NOₓ emissions using deep learning: Integrating in situ observations with a satellite-based chemical reanalysis", Atmospheric Chemistry and Physics, 22(21):14059-14074, doi:10.5194/acp-22-14059-2022 ↩
Metadata
Release files for unox 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| unox-0.1.2.tar.gz | 84.9 kB | Without provenance | Details for unox-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| unox-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for unox-0.1.2-py3-none-any.whl |
Total release size: 187.7 kB
Release files / unox-0.1.2.tar.gz
| Download URL | unox-0.1.2.tar.gz |
|---|---|
| Size | 84.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a21b0ef6e53719a6975bf73bf5f36d69236566067ee155e2760e48ef5d4c68c7
|
|
BLAKE2b-256 checksum How to use checksums |
4f267a6bdb2d2edfb978c4955c8638a9292563e324aa5ddf4d61ed487134a7b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.2 CPython/3.9.21 Linux/5.15.0-170-generic
|
Release files / unox-0.1.2-py3-none-any.whl
| Download URL | unox-0.1.2-py3-none-any.whl |
|---|---|
| Size | 102.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0896a9d25386dacacd1b19a1be14880b30e73d71bb4b3e482fdcdca24f5cf508
|
|
BLAKE2b-256 checksum How to use checksums |
7b6c2a59304e06499fa38af602e9b7f3a1b38088f4bb04ed761b1575a4256b81
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.2 CPython/3.9.21 Linux/5.15.0-170-generic
|
Security for unox 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.