ClimAg docs

Documentation and Jupyter notebooks for the ClimAg research project. Available at: https://climag.readthedocs.io.

Acknowledgements

ClimAg is a three-year research project funded by the Environmental Protection Agency (EPA) under the Climate Change Research Programme grant number 2018-CCRP-MS.50, with additional funding provided under the COVID-19 research support scheme of the Higher Education Authority.

The Python implementation of the ModVege pasture model adapted for use in this project was translated from Java to Python by Y. Chemin of JRC Ispra. This Python implementation was originally published as public domain software on GitHub under the Unlicence license. The Java model was provided by R. Martin of INRAE UREP Clermont-Ferrand for the original Python implementation. The original ModVege pasture model was developed by Jouven et al..

Installation

This project uses Conda with Python 3.10.

Note

Windows users should use Conda within Windows Subsystem for Linux (WSL), as some packages (e.g. CDO) are unavailable for Windows.

Clone the ClimAg repository including submodules:

git clone --recurse-submodules https://github.com/ClimAg/ClimAg.git

Navigate to the directory of the cloned repository:

cd ClimAg

Create a virtual environment and install all requirements:

conda env create

Activate the virtual environment:

conda activate ClimAg

To run tests:

python -m pytest --cov

To update the virtual environment:

conda env update

To build the documentation locally:

cd docs && make html

To clean build the documentation locally:

cd docs && make clean html

Licence

Copyright 2022-2024 N. Streethran

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.