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.
⚠ cgeniepy is in beta stage with main functionalities being accompolished.
- 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 from conda
conda install --channel "ruiying" cgeniepy- Install extra dependency
python3 -m pip install "cgeniepy[extra]"- Update package
pip install --upgrade cgeniepyI 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).
An online documentation is hosted in readthedoc.
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 is designed by me using free righteous font.
- Prof. Andy Ridgwell's muffinplot
- Dr. Alex Phol's genie_basicdiags
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.
