README.md

TOAR Gridding Tool

About

The TOARgridding projects data from the TOAD database (https://toar-data.fz-juelich.de/) onto a grid. The request to the database also allows a statistical analysis of the requested value. The mean and standard deviation of all stations within a cell are computed.

The tool handles the request to the database over the REST API and the subsequent processing. The results of the gridding are provided as xarray objects for subsequent processing by the user.

This project is in beta with the intended basic functionalities. The documentation is work in progress.

Requirements

TBD, see pyproject.toml

Installation

Move to the folder you want to create download this project to. We now need to download the source code (https://gitlab.jsc.fz-juelich.de/esde/toar-public/toargridding/-/tree/dev?ref_type=heads). Either as ZIP folder or via git:

Download with GIT

Clone the project from its git repository:

git clone https://gitlab.jsc.fz-juelich.de/esde/toar-public/toargridding.git 

With git we need to checkout the development branch (dev). Therefore we need to change to the project directory first:

cd toargridding
git checkout dev

Installing Dependencies and Setting up Virtual Enviorment

The handling of required packages is done with poetry (https://python-poetry.org/). After installing poetry, you can simply install all required dependencies for this project by runing poetry in the project directory:

poetry install

This also creates a virtual enviorment, which ensures that different projects do not interfere with their dependencies. To run a jupyter notebook in the virtual enviorment execute

poetry run jupyter notebook

and to run a script use