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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cgeniepy-0.15.2.tar.gz.
File metadata
- Download URL: cgeniepy-0.15.2.tar.gz
- Upload date:
- Size: 8.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.1 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e6bf6cadb93f9067af4fd10fedd20da18a13a037caf635541165bc8116b288c7
|
|
| MD5 |
2504f47b69e4a86bef74768de807922b
|
|
| BLAKE2b-256 |
ae96bf74420fad74316629815b9bfa99ee04503049016dc2df19a9800d59dd5d
|
File details
Details for the file cgeniepy-0.15.2-py3-none-any.whl.
File metadata
- Download URL: cgeniepy-0.15.2-py3-none-any.whl
- Upload date:
- Size: 8.7 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.1 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5f2c11aa4b33bbc01f92805334df27ef302657bb25077ffaaa395d3c41ca9a4e
|
|
| MD5 |
a4a2d9e387380f3bae740527ab251b9b
|
|
| BLAKE2b-256 |
b4a2c27ea0c081b4c122cc5b9510da215d37213162771a6ed6474982b9bad958
|
