geoschem-gcpy

Python toolkit for GEOS-Chem. Contains basic plotting scripts, plus the suite of GEOS-Chem benchmarking utilities.

https://github.com/geoschem/gcpy

Science Score: 59.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    11 of 16 committers (68.8%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.5%) to scientific vocabulary

Keywords

atmospheric-chemistry atmospheric-modelling benchmarking cartopy cloud-computing geos-chem numpy plots plotting-in-python python python-toolkit scientific-computing visualization-tools xarray

Keywords from Contributors

mesh interpretability sequences generic projection interactive optim hacking network-simulation
Last synced: 6 months ago · JSON representation

Repository

Python toolkit for GEOS-Chem. Contains basic plotting scripts, plus the suite of GEOS-Chem benchmarking utilities.

Basic Info
  • Host: GitHub
  • Owner: geoschem
  • License: other
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage: https://gcpy.readthedocs.io
  • Size: 10.1 MB
Statistics
  • Stars: 54
  • Watchers: 8
  • Forks: 27
  • Open Issues: 25
  • Releases: 24
Topics
atmospheric-chemistry atmospheric-modelling benchmarking cartopy cloud-computing geos-chem numpy plots plotting-in-python python python-toolkit scientific-computing visualization-tools xarray
Created over 7 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Support Authors Zenodo

README.md

GCPy: Python toolkit for GEOS-Chem

PyPI - Version
DOI

GCPy is a Python-based toolkit containing useful functions for working specifically with the GEOS-Chem model of atmospheric chemistry and composition.

GCPy aims to build on the well-established scientific Python technical stack, leveraging tools like cartopy, numpy, and xarray to simplify the task of working with GEOS-Chem model output and performing atmospheric chemistry analyses.

What GCPy was intended to do:

  1. Produce plots and tables from GEOS-Chem output using simple function calls.
  2. Generate the standard evaluation plots and tables for GEOS-Chem benchmark simulations.
  3. Obtain GEOS-Chem's horizontal and vertical grid information.
  4. Implement GCHP-specific regridding functionalities (e.g. cubed-sphere to lat-lon regridding)
  5. Provide example scripts for creating specific types of plots or analysis from GEOS-Chem output.
  6. Provide user-submitted scripts for specific applications related to GEOS-Chem and HEMCO.

What GCPy was not intended to do:

  1. General NetCDF file modification: (crop a domain, extract some variables):

  2. Statistical analysis:

  3. Machine Learning:

Documentation:

For more information on installing and using GCPy, visit the official documentation at gcpy.readthedocs.io.

License

GCPy is distributed under the MIT license. Please see the GCPy license agreement and List of GCPy developers for more information.

Requesting support

To report a bug or suggest a new feature, please see our Support Guidelines.

Submitting new features

If you are interested in submitting code to GCPy, please see our Contributing Guidelines.

Owner

  • Name: GEOS-Chem
  • Login: geoschem
  • Kind: organization
  • Email: geos-chem-support@g.harvard.edu
  • Location: International

The GEOS-Chem model of atmospheric chemistry and composition

GitHub Events

Total
  • Create event: 24
  • Issues event: 9
  • Release event: 2
  • Watch event: 5
  • Delete event: 19
  • Issue comment event: 22
  • Push event: 76
  • Pull request review comment event: 13
  • Pull request review event: 36
  • Pull request event: 39
  • Fork event: 3
Last Year
  • Create event: 24
  • Issues event: 9
  • Release event: 2
  • Watch event: 5
  • Delete event: 19
  • Issue comment event: 22
  • Push event: 76
  • Pull request review comment event: 13
  • Pull request review event: 36
  • Pull request event: 39
  • Fork event: 3

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 1,521
  • Total Committers: 16
  • Avg Commits per committer: 95.063
  • Development Distribution Score (DDS): 0.52
Past Year
  • Commits: 93
  • Committers: 5
  • Avg Commits per committer: 18.6
  • Development Distribution Score (DDS): 0.14
Top Committers
Name Email Commits
Bob Yantosca y****a@s****u 730
Will Downs w****s@g****u 269
Lizzie Lundgren e****n@s****u 239
Melissa Sulprizio m****r@s****u 116
darothen d****n@m****u 34
laestrada l****0@g****m 32
Liam Bindle l****e@g****m 31
JiaweiZhuang j****g@g****u 18
Sebastian D. Eastham s****m@m****u 17
Killian Murphy k****y@y****k 14
Yuanjian Zhang y****z@w****u 10
dependabot[bot] 4****] 6
Lucas Estrada l****a@h****u 2
Hannah O Nesser h****r@g****m 1
jmoch1214 j****h@g****u 1
Tomas Sherwen t****n@T****l 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 231
  • Total pull requests: 154
  • Average time to close issues: 4 months
  • Average time to close pull requests: 9 days
  • Total issue authors: 40
  • Total pull request authors: 14
  • Average comments per issue: 2.87
  • Average comments per pull request: 1.25
  • Merged pull requests: 130
  • Bot issues: 0
  • Bot pull requests: 15
Past Year
  • Issues: 8
  • Pull requests: 47
  • Average time to close issues: 16 days
  • Average time to close pull requests: 8 days
  • Issue authors: 4
  • Pull request authors: 6
  • Average comments per issue: 0.75
  • Average comments per pull request: 0.53
  • Merged pull requests: 38
  • Bot issues: 0
  • Bot pull requests: 3
Top Authors
Issue Authors
  • lizziel (68)
  • yantosca (56)
  • msulprizio (39)
  • WilliamDowns (9)
  • TylerElgiar (5)
  • 1Dandan (4)
  • jmoch1214 (4)
  • laestrada (4)
  • barronh (3)
  • tsherwen (2)
  • Aosrain (2)
  • sdeastham (2)
  • SadiaToma (2)
  • liwenjia12 (2)
  • LyssaFreese (1)
Pull Request Authors
  • yantosca (101)
  • dependabot[bot] (21)
  • msulprizio (19)
  • lizziel (18)
  • LiamBindle (10)
  • yuanjianz (6)
  • laestrada (5)
  • kilicomu (3)
  • sdeastham (1)
  • tsherwen (1)
  • hannahnesser (1)
  • Jourdan-He (1)
  • 1Dandan (1)
  • jmoch1214 (1)
Top Labels
Issue Labels
bug (93) feature (78) benchmark plots and tables (39) never stale (22) question (20) stale (18) environment (14) category: Bug (12) category: Feature Request (11) topic: Benchmark Plots and Tables (9) cubed-sphere (9) topic: Regridding (6) no-issue-activity (6) structural modification (5) regridding (5) discussion (5) colors / display (4) topic: Community Contributions (3) category: Question (3) github actions (2) topic: User Environment (2) topic: Structural Modifications (2) topic: Dependencies (1) help needed: Request Input from Community (1) help needed: Open Research Problem (1) utilities (1) dependencies (1) topic: Installation (1) TODO: Documentation (1) topic: Cubed-Sphere Grid (1)
Pull Request Labels
benchmark plots and tables (41) category: Feature Request (41) category: Bug Fix (35) feature (31) topic: Benchmark Plots and Tables (30) bugfix (25) dependencies (17) structural modification (13) environment (12) topic: Example Scripts (11) topic: User Environment (8) regridding (6) bug (6) topic: Utilities (6) topic: Regridding (6) topic: Dependencies (6) documentation (5) topic: GitHub (5) topic: Structural Modifications (4) github actions (4) topic: GitHub Actions (3) topic: Cubed-Sphere Grid (3) never stale (3) python (3) utilities (2) cubed-sphere (2) colors / display (2) topic: Stretched Grid (1) topic: Community Contributions (1) topic: Input Data (1)

Packages

  • Total packages: 3
  • Total downloads:
    • pypi 269 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 28
  • Total maintainers: 2
proxy.golang.org: github.com/geoschem/gcpy
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
pypi.org: geoschem-gcpy
  • Versions: 16
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 269 Last month
Rankings
Dependent packages count: 7.3%
Forks count: 8.1%
Stargazers count: 9.7%
Average: 15.7%
Dependent repos count: 22.1%
Downloads: 31.5%
Maintainers (2)
Last synced: 6 months ago
conda-forge.org: geoschem-gcpy
  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Forks count: 33.2%
Dependent repos count: 34.0%
Stargazers count: 39.1%
Average: 39.4%
Dependent packages count: 51.2%
Last synced: 6 months ago

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
.github/workflows/codeql.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/autobuild v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/pylint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/stale.yml actions
  • actions/stale v5 composite
.github/workflows/build-gcpy-environment.yml actions
  • actions/checkout v2 composite
  • mamba-org/setup-micromamba v1 composite
.github/workflows/build-test-environment.yml actions
  • actions/checkout v2 composite
  • mamba-org/setup-micromamba v1 composite
setup.py pypi
  • awscli ==2.13.39
  • cartopy ==0.22.0
  • cf_xarray ==0.8.4
  • dask ==2023.9.2
  • docutils ==0.16
  • esmf ==8.1.1
  • esmpy ==8.1.1
  • gridspec ==0.1.0
  • ipython ==8.15.0
  • jinja2 ==3.0.3
  • joblib ==1.3.2
  • jupyter ==1.0.0
  • matplotlib ==3.8.0
  • netcdf-fortran ==4.5.4
  • netcdf4 ==1.6.0
  • numpy ==1.26.0
  • pandas ==2.1.1
  • pip ==23.2.1
  • pylint ==2.17.5
  • pypdf ==3.16.1
  • pyproj ==3.6.1
  • python ==3.9.18
  • recommonmark ==0.7.1
  • requests ==2.31.0
  • scipy ==1.11.2
  • sparselt ==0.1.3
  • sphinx ==3.5.4
  • sphinx-autoapi ==1.9.0
  • sphinx-autobuild ==2021.3.14
  • sphinx_rtd_theme ==0.5.2
  • sphinxcontrib-bibtex ==2.2.0
  • tabulate ==0.9.0
  • tk ==8.6.12
  • xarray ==2023.8.0
  • xesmf ==0.5.1
docs/environment_files/environment.yml pypi
environment.yml pypi