Skip to content

kthyng/cgeniepy

 
 

Repository files navigation

Documentation Status PyPI version PyPI - Downloads License: GPL v3 status

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.

Installation

  1. Install from PyPI.
python3 -m pip install cgeniepy
  1. Install from GitHub:
python3 -m pip install git+https://github.com/ruiying-ocean/cgeniepy.git@master
  1. Install extra dependency
python3 -m pip install "cgeniepy[extra]"

Quickstart

I have uploaded a sample model run, which is a preindustrial spinup configuration with marine ecosystem and biogeochemistry enabled.

import cgeniepy

model = cgeniepy.sample_model()
model.get_var('ocn_sur_temp').isel(time=-1).plot(colorbar=True)

Documentation

An online documentation is hosted in readthedoc.

Citation

Rui Ying. cgeniepy: A Python package for analysing cGENIE Earth System Model output, 20 February 2024, PREPRINT (Version 1) available at Research Square [https://doi.org/10.21203/rs.3.rs-3967633/v1]

Logo

Logo is designed by me using free righteous font.

Alternative

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

How to contribute

About

A Python package for analysing the cGENIE model output

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Roff 62.3%
  • ReScript 33.6%
  • Python 3.0%
  • TeX 0.4%
  • Arc 0.4%
  • Shell 0.3%