gicait / PyAEZ

PyAEZ is a python package consisted of many algorithms related to Agro-ecalogical zoning (AEZ) framework.
MIT License
74 stars 51 forks source link

Downloads PyPI version License: MIT

PyAEZ

PyAEZ is a python package consisted of many algorithms related to Agro-ecalogical zoning (AEZ) framework. PyAEZ tries to encapsulate all complex calculations in AEZ and try to provide user friendly, and intuitive ways to input data and output results after calculations.

Installation

Now the package can be installed using pip command as below,

pip install pyaez==2.2

Alternatively, can be installed using using conda command as below,

conda install -c conda-forge pyaez

Introduction

PyAEZ includes 6 main modules as below. Additionally to that, UtilityCalculations module is also included in PyAEZ to perform additional related utility calculations.

Other than 6 main modules and utility module, following 3 major algorithms related to AEZ also are included in PyAEZ. Those 3 major algorithms can be utilized individually without running whole PyAEZ.

Dependencies

Step-by-step Process

Following 6 Jupyter notebooks in the GitHub repository can be used as worked full example for PyAEZ 6 major modules.

Note: _NB2CropSimulation.ipynb takes a huge amount of time due to automatic crop calendar calculations. Hence, we have rewritten core parts of PyAEZ (CropWatCalc.py, BioMassCalc.py and ETOCalc.py) with Numba compatible manner as well. Numba translates Python functions to optimized machine code at runtime, allowing calculation speeds close to C or FORTRAN.

Release Note PyAEZv2.2

The improvement of the overall accuracy and reliability of the AEZ methodology is covered in new version in Module 2, 3, and input data usage is modified in Module 4 & 5. The key updates are listed as follows:

Module 2:

Module 3:

Module 4:

Module 5:

Documentation

API Documentation is located in "docs" folder.

Citation

Use this bibtex to cite us.

@misc{PyAEZ(v2.2),
  title={PyAEZ Python Package for Agro-ecological zoning (AEZ)},
  author={Swun Wunna Htet, Kittiphon Boonma, Guenther Fischer, Gianluca Franceschini, N. Lakmal Deshapriya, Thaileng Thol, Kavinda Gunasekara, Rajendra Shrestha,  Freddy Nachtergaele, Monica Petri, Beau Damen},
  year={2023},
  publisher={Github},
  journal={GitHub repository},
  howpublished={\url{https://github.com/gicait/PyAEZ}},
}

Developed by

Geoinformatics Center of Asian Institute of Technology.

Funding

Food and Agriculture Organization of the United Nations (FAO) and FAO SAMIS (Strengthening Agro-climatic Monitoring and Information System) Project in Lao PDR.

Sample Data Source

Major AEZ References