Metadata-Version: 2.1
Name: fao56-model
Version: 0.1.2
Summary: A Python package for FAO-56 model calculations.
License: MIT
Author: Stephan Smit
Author-email: stephansmit@hotmail.com
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: datetimerange (>=2.2.0,<3.0.0)
Requires-Dist: matplotlib (>=3.8.3,<4.0.0)
Requires-Dist: pandas (>=2.2.0,<3.0.0)
Requires-Dist: pydantic (>=2.6.1,<3.0.0)
Description-Content-Type: text/markdown

# Fao56 Model

[![Build Main](https://github.com/stephansmit/fao56_model/actions/workflows/build-main.yml/badge.svg)](https://github.com/stephansmit/fao56_model/actions/workflows/build-main.yml)

This is an implementation of the [FAO56 model](https://www.fao.org/3/X0490E/x0490e00.htm).



## TO DO

- [ ] add the crop dependant and stage dependent crop yield reduction factor
- [ ] add the crop coefficient correction for the initial stage
- [ ] generalize the output
- [ ] add the dual crop coefficient method
- [ ] add more crops to the database
- [ ] validate the model using the FAO56 data
- [ ] add tests


## Development

To install all the dependencies

```
poetry install --with dev
```

Install the pre-commit hooks
    
```
pre-commit install
```
    
To test

```
poetry run pytest
```

Bump the version to publish
    
```
poetry version patch
git add fao56_model
git commit -am 'Bump version'
git push
```

