Metadata-Version: 2.1
Name: cgeniepy
Version: 0.5
Summary: A Python wrapper package to analyse and visualise cGENIE model output
Author: Rui Ying
Author-email: rui.ying@bristol.ac.uk
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

This is an open-source Python package used in my Ph.D project to analyse and visualise [cGENIE model](https://www.seao2.info/mymuffin.html) output (mostly in netCDF format).


## Main features 🐛

### 1. visualisation based on Matplotlib
- Map for 2D cGENIE array
- Ocean Transection Contour 
- Taylor diagram

### 2. chemistry system
Parse a molecular formula and get its molecular mass

### 3. unit system
unit conversion using `pint`

### 4. ocean basin detection
input latitude/longitude to get where the site is in.


## Installation 🙂

```bash
python3 -m pip install -i https://test.pypi.org/simple/ cgeniepy==0.5
```

## Code style

ReST as docstring style, black as code style.

## Project TODO 🚩

- [] Documentation built by `sphinx` 
- [] Examples
- [] Unit Tests
- [X] add decorator for plot object

## Structure

the essential is to pass the model path string until the code finally get data from it.

Class: GenieModel -> EcoModel; GenieVariable -> PlanktonBiomass/PlanktonExport -> ForamBiomass/ForamExport;
