{"id":33325926,"url":"https://github.com/ruiying-ocean/cgeniepy","last_synced_at":"2026-01-17T11:24:50.444Z","repository":{"id":182151877,"uuid":"523869938","full_name":"ruiying-ocean/cgeniepy","owner":"ruiying-ocean","description":"A Python package for analysing the cGENIE model output","archived":false,"fork":false,"pushed_at":"2025-10-11T20:16:54.000Z","size":32483,"stargazers_count":8,"open_issues_count":4,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-08T02:39:29.435Z","etag":null,"topics":["cgenie","earth-sciences","earth-system-model","oceanography","python","visualisation"],"latest_commit_sha":null,"homepage":"https://cgeniepy.readthedocs.io/en/latest","language":"Roff","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ruiying-ocean.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-08-11T21:11:17.000Z","updated_at":"2025-10-26T19:41:18.000Z","dependencies_parsed_at":"2023-10-16T13:12:07.712Z","dependency_job_id":"4d72df8b-ee7d-43c6-871e-a73663148d9d","html_url":"https://github.com/ruiying-ocean/cgeniepy","commit_stats":null,"previous_names":["ruiying-ocean/cgeniepy"],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/ruiying-ocean/cgeniepy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruiying-ocean%2Fcgeniepy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruiying-ocean%2Fcgeniepy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruiying-ocean%2Fcgeniepy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruiying-ocean%2Fcgeniepy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ruiying-ocean","download_url":"https://codeload.github.com/ruiying-ocean/cgeniepy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruiying-ocean%2Fcgeniepy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28507144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T10:25:30.148Z","status":"ssl_error","status_checked_at":"2026-01-17T10:25:29.718Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cgenie","earth-sciences","earth-system-model","oceanography","python","visualisation"],"created_at":"2025-11-20T10:00:35.598Z","updated_at":"2026-01-17T11:24:50.425Z","avatar_url":"https://github.com/ruiying-ocean.png","language":"Roff","funding_links":[],"categories":["Climate Change"],"sub_categories":["Climate Data Processing and Analysis"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"logo.png\"/\u003e\n\u003c/p\u003e\n\n[![Documentation Status](https://readthedocs.org/projects/cgeniepy/badge/?version=latest)](https://cgeniepy.readthedocs.io/en/latest/?badge=latest)\n[![PyPI version](https://badge.fury.io/py/cgeniepy.svg)](https://badge.fury.io/py/cgeniepy)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/cgeniepy)\n[![DOI](https://joss.theoj.org/papers/10.21105/joss.06762/status.svg)](https://doi.org/10.21105/joss.06762)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13799838.svg)](https://doi.org/10.5281/zenodo.13799838)\n[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n\n`cgeniepy` is a Python package to analyse the output of [cGENIE Earth System Model](https://www.seao2.info/mymuffin.html). 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.\n\n\n## Installation\n\n1. Install from [PyPI](https://pypi.org/project/cgeniepy/) by running commands below in your terminal.\n\n```bash\npython3 -m pip install cgeniepy\n```\n\n2. Install from GitHub:\n\n```bash\npython3 -m pip install git+https://github.com/ruiying-ocean/cgeniepy.git@master\n```\n\n3. Install extra dependency\n```bash\npython3 -m pip install \"cgeniepy[extra]\"\n```\n\n4. Install using uv\n```bash\nuv add cgeniepy\n```\n\n5. Update package\n```bash\npip install --upgrade cgeniepy\n```\n\n\n## Quickstart\nI have uploaded a sample model run, which is a [preindustrial spinup configuration](https://doi.org/10.5194/gmd-17-1729-2024) with marine ecosystem and biogeochemistry enabled (C, P, Fe, Si, O). \n\n```python\nimport cgeniepy\nfrom cgeniepy.model import GenieModel\n\nmodel = cgeniepy.sample_model()\n## for your own model experiment\nmodel = GenieModel(\"directory_to_your_model_output\")\n\n## select variable -\u003e select coordinate -\u003e operation like mean or plot\nmodel.get_var('ocn_sur_temp').isel(time=-1).plot(colorbar=True)\n```\n\n* If you want to try other cGENIE model runs, you may go to this zenodo record (https://zenodo.org/records/10575295). \n* If you want to try non-cGENIE model, I have also uploaded two example files to here (https://zenodo.org/records/13786014). \n\n\n## Documentation\n\n[An online documentation is hosted in readthedoc.](https://cgeniepy.readthedocs.io/en/latest/)\n\n\n\n## Citation\n\nYing, 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\n\n## Logo\n\nLogo is designed by me using free **righteous** font.\n\n## Alternative\n* Prof. Andy Ridgwell's [muffinplot](https://github.com/derpycode/muffinplot)\n* Dr. Alex Phol's [genie_basicdiags](https://github.com/alexpohl/genie_basicdiags/)\n\n## Raise a bug\n\nPlease 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.\n\n## Contributing\n\n[How to contribute](CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruiying-ocean%2Fcgeniepy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruiying-ocean%2Fcgeniepy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruiying-ocean%2Fcgeniepy/lists"}