CHEEREIO

The CHEmistry and Emissions REanalysis Interface with Observations is a set of Python and shell scripts that support data assimilation and emissions inversions for arbitrary runs of the GEOS-Chem chemical transport model via an ensemble approach.
https://github.com/drewpendergrass/cheereio

Category: Emissions
Sub Category: Emission Observation and Modeling

Last synced: about 22 hours ago
JSON representation

Repository metadata

This repository contains the code for CHEEREIO, which supports data assimilation and emissions inversions for arbitrary runs of the GEOS-Chem chemical transport model via an ensemble approach (i.e. without the model adjoint).

README.md

Documentation Status

DOI

CHEEREIO

The CHEmistry and Emissions REanalysis Interface with Observations (CHEEREIO) is a set of Python and shell scripts that support data assimilation and emissions inversions for arbitrary runs of the GEOS-Chem chemical transport model via an ensemble approach (i.e. without the model adjoint). CHEEREIO follows four design principles:

  1. Easy to customize: Assimilate anything, in any GEOS-Chem configuration or simulation.
  2. Easy to maintain: Science automatically aligned with latest model version.
  3. Easy to deploy: One configuration file controls installation and settings
  4. Easy to link observations: Object-oriented observation operator implementation allows the user to rapidly add new kinds of data with minimal programming required.

Installation

Follow the guide on the documentation for installation. When you clone this repository, we recommend that you check out the latest release of CHEEREIO rather than using the main branch; this ensures reproducibility and minimizes bugs.

Citation

If you use CHEEREIO in your work, please cite our model description paper: Pendergrass, D. C., Jacob, D. J., Nesser, H., Varon, D. J., Sulprizio, M., Miyazaki, K., & Bowman, K. W. (2023). CHEEREIO 1.0: A versatile and user-friendly ensemble-based chemical data assimilation and emissions inversion platform for the GEOS-Chem chemical transport model. Geoscientific Model Development, 16(16), 4793–4810. https://doi.org/10.5194/gmd-16-4793-2023

Documentation

Detailed documentation is available on ReadTheDocs, including installation instructions. If you encounter any problems not covered by the documentation, please open an issue on GitHub. CHEEREIO has an official website: cheere.io

About CHEEREIO

The CHEmistry and Emissions REanalysis Interface with Observations (CHEEREIO) is a package that wraps the GEOS-Chem chemical transport model source code. After a simple modification of a single configuration file (ens_config.json), CHEEREIO automatically produces and compiles a template GEOS-Chem run directory, which it then copies into an ensemble. Each ensemble member comes with a randomized set of gridded emissions scaling factors for species specified by the user. As the ensemble of runs progresses, CHEEREIO will periodically pause the ensemble, compare with a set of observations (i.e. satellite, surface, and/or aircraft), and update relevant emissions scaling factors and chemical concentrations to best match reality given the uncertainties of measurements and model. CHEEREIO calculates this update via the 4D Asynchronous Localized Ensemble Transform Kalman Filter (4D-LETKF) as described in Hunt. et. al., [2007]. Because this approach is model agnostic (specifically, it does not rely on the adjoint), CHEEREIO supports emissions updates and chemical concentration corrections for arbitrary configurations of the GEOS-Chem model. However, the current CHEEREIO codebase assumes that GEOS-Chem code is version 13.0.0 or later (version 14 is supported)!


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 7 days ago

Total Commits: 1,692
Total Committers: 17
Avg Commits per committer: 99.529
Development Distribution Score (DDS): 0.206

Commits in past year: 82
Committers in past year: 4
Avg Commits per committer in past year: 20.5
Development Distribution Score (DDS) in past year: 0.049

Name Email Commits
Drew Pendergrass p****w@g****m 1343
drewpendergrass p****w@g****m 328
Drew Pendergrass d****s@h****u 3
Drew Pendergrass a****s@d****u 2
Drew Pendergrass d****s@b****u 2
Drew Pendergrass d****s@h****u 2
Drew Pendergrass d****s@h****u 2
Andrew Pendergrass a****1@d****u 1
Andrew Pendergrass a****1@d****u 1
Drew Pendergrass d****s@b****u 1
Drew Pendergrass d****s@h****u 1
Drew Pendergrass d****s@h****u 1
Drew Pendergrass d****s@h****u 1
Sina Voshtani s****o@n****l 1
Bob Yantosca y****a@s****u 1
Sina Voshtani s****i@u****a 1
Yunxiao Tang t****0@g****m 1

Committer domains:


Issue and Pull Request metadata

Last synced: 7 days ago

Total issues: 5
Total pull requests: 4
Average time to close issues: 13 days
Average time to close pull requests: about 4 hours
Total issue authors: 3
Total pull request authors: 3
Average comments per issue: 1.4
Average comments per pull request: 0.0
Merged pull request: 3
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 1
Past year average time to close issues: N/A
Past year average time to close pull requests: less than a minute
Past year issue authors: 0
Past year pull request authors: 1
Past year average comments per issue: 0
Past year average comments per pull request: 0.0
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/drewpendergrass/cheereio

Top Issue Authors

  • HuiruZhong (3)
  • YunxiaoT (1)
  • zion0210 (1)

Top Pull Request Authors

  • drewpendergrass (2)
  • YunxiaoT (1)
  • Sinavo (1)

Top Issue Labels

Top Pull Request Labels


Dependencies

docs/requirements.txt pypi
  • docutils ==0.16
  • jinja2 ==3.0.3
  • recommonmark *
  • sphinx ==3.5.4
  • sphinx_rtd_theme ==0.5.2
  • sphinxcontrib-bibtex ==2.2.0

Score: 5.777652323222656