cgeniepy
A Python package to analyse the output of cGENIE Earth System Model.
https://github.com/ruiying-ocean/cgeniepy
Category: Climate Change
Sub Category: Climate Data Processing and Analysis
Keywords
cgenie earth-sciences earth-system-model oceanography python visualisation
Last synced: about 8 hours ago
JSON representation
Repository metadata
A Python package for analysing the cGENIE model output
- Host: GitHub
- URL: https://github.com/ruiying-ocean/cgeniepy
- Owner: ruiying-ocean
- License: gpl-3.0
- Created: 2022-08-11T21:11:17.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2026-02-03T20:48:12.000Z (6 days ago)
- Last Synced: 2026-02-05T11:29:51.196Z (4 days ago)
- Topics: cgenie, earth-sciences, earth-system-model, oceanography, python, visualisation
- Language: ReScript
- Homepage: https://cgeniepy.readthedocs.io/en/latest
- Size: 31 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 4
- Releases: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Citation: CITATION.cff
README.md
cgeniepy is a Python package to analyse the output of cGENIE Earth System Model. It aims to provide a set of convenient tools for the post-simulation work, including analysing the model output, plotting publication-quality figures, and conducting model-data comparison.
Installation
- Install from PyPI by running commands below in your terminal.
python3 -m pip install cgeniepy
- Install from GitHub:
python3 -m pip install git+https://github.com/ruiying-ocean/cgeniepy.git@master
- Install extra dependency
python3 -m pip install "cgeniepy[extra]"
- Install using uv
uv add cgeniepy
- Update package
pip install --upgrade cgeniepy
Quickstart
I have uploaded a sample model run, which is a preindustrial spinup configuration with marine ecosystem and biogeochemistry enabled (C, P, Fe, Si, O).
import cgeniepy
from cgeniepy.model import GenieModel
model = cgeniepy.sample_model()
## for your own model experiment
model = GenieModel("directory_to_your_model_output")
## select variable -> select coordinate -> operation like mean or plot
model.get_var('ocn_sur_temp').isel(time=-1).plot(colorbar=True)
- If you want to try other cGENIE model runs, you may go to this zenodo record (https://zenodo.org/records/10575295).
- If you want to try non-cGENIE model, I have also uploaded two example files to here (https://zenodo.org/records/13786014).
Documentation
An online documentation is hosted in readthedoc.
Citation
Ying, R. (2024). cgeniepy: A Python package for analysing cGENIE Earth System Model output. Journal of Open Source Software, 9(101), 6762. https://doi.org/10.21105/joss.06762
Logo
Logo is designed by me using free righteous font.
Alternative
- Prof. Andy Ridgwell's muffinplot
- Dr. Alex Phol's genie_basicdiags
Raise a bug
Please use GitHub's Issues to raise a bug. This makes the issues traceable so that future users having the same problem can find the answer in the public domain.
Contributing
Citation (CITATION.cff)
cff-version: "1.2.0"
authors:
- email: rui.ying@bristol.ac.uk
family-names: Ying
given-names: Rui
orcid: "https://orcid.org/0000-0001-5811-2388"
contact:
- email: rui.ying@bristol.ac.uk
family-names: Ying
given-names: Rui
orcid: "https://orcid.org/0000-0001-5811-2388"
doi: 10.5281/zenodo.13835532
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- email: rui.ying@bristol.ac.uk
family-names: Ying
given-names: Rui
orcid: "https://orcid.org/0000-0001-5811-2388"
date-published: 2024-09-30
doi: 10.21105/joss.06762
issn: 2475-9066
issue: 101
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 6762
title: "cgeniepy: A Python package for analysing cGENIE Earth System
Model output"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.06762"
volume: 9
title: "cgeniepy: A Python package for analysing cGENIE Earth System
Model output"
Owner metadata
- Name:
- Login: ruiying-ocean
- Email:
- Kind: user
- Description: PhD student studying marine system and biogeochemical cycle. Emacs lover.
- Website: www.ruiying.online
- Location: Bristol, UK
- Twitter: YingRui17
- Company: University of Bristol
- Icon url: https://avatars.githubusercontent.com/u/38958822?u=212dc2f678ce58c12575c78851372d1512b83945&v=4
- Repositories: 4
- Last ynced at: 2023-07-18T22:42:06.847Z
- Profile URL: https://github.com/ruiying-ocean
GitHub Events
Total
- Delete event: 1
- Pull request event: 1
- Issues event: 18
- Watch event: 2
- Issue comment event: 6
- Push event: 65
- Create event: 9
Last Year
- Issues event: 7
- Watch event: 1
- Issue comment event: 1
- Push event: 26
- Create event: 1
Committers metadata
Last synced: 11 days ago
Total Commits: 535
Total Committers: 4
Avg Commits per committer: 133.75
Development Distribution Score (DDS): 0.062
Commits in past year: 60
Committers in past year: 2
Avg Commits per committer in past year: 30.0
Development Distribution Score (DDS) in past year: 0.5
| Name | Commits | |
|---|---|---|
| Rui Ying (Mac) | 3****n | 502 |
| Rui Ying (UEA MAC) | r****g@u****k | 30 |
| Rachel Wegener | 3****2 | 2 |
| Kristen Thyng | k****g@g****m | 1 |
Committer domains:
- uea.ac.uk: 1
Issue and Pull Request metadata
Last synced: about 1 month ago
Total issues: 24
Total pull requests: 6
Average time to close issues: 9 days
Average time to close pull requests: about 5 hours
Total issue authors: 2
Total pull request authors: 3
Average comments per issue: 0.58
Average comments per pull request: 0.17
Merged pull request: 5
Bot issues: 0
Bot pull requests: 0
Past year issues: 13
Past year pull requests: 2
Past year average time to close issues: about 21 hours
Past year average time to close pull requests: 1 minute
Past year issue authors: 1
Past year pull request authors: 1
Past year average comments per issue: 0.15
Past year average comments per pull request: 0.0
Past year merged pull request: 2
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- ruiying-ocean (21)
- koldunovn (3)
Top Pull Request Authors
- rwegener2 (2)
- kthyng (2)
- ruiying-ocean (2)
Top Issue Labels
- enhancement (9)
- bug (1)
Top Pull Request Labels
Dependencies
Score: 3.8712010109078907