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
Metadata
1 maintainer
Release files for cgeniepy 0.16.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cgeniepy-0.16.0.tar.gz | 8.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cgeniepy-0.16.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 17.3 MB
Release files / cgeniepy-0.16.0.tar.gz
| Download URL | cgeniepy-0.16.0.tar.gz |
|---|---|
| Size | 8.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9fd9e1c22c4790e5714bdb201ae97007c2a9a79db061e30f6f70b382865496ee
|
|
BLAKE2b-256 checksum How to use checksums |
24a43fd7652458a4f3106cc48d2f48a77b2d146604cf9a55b149a86de4a46fd4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / cgeniepy-0.16.0-py3-none-any.whl
| Download URL | cgeniepy-0.16.0-py3-none-any.whl |
|---|---|
| Size | 8.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d41548240f8abc8b055f5c4dd6f5a5f529bf8484f65e93e4ecd611dc1a1b61d
|
|
BLAKE2b-256 checksum How to use checksums |
888e67d84a575c8bdebf02086025564de097e5a60abf646bed6d63cc6e6faf03
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
