Skip to content

vergauwenthomas/MetObs_toolkit

Repository files navigation

MetObs-toolkit

PyPI version Documentation Status status Tests passing DOI

drawing

The MetObs-toolkit provides a comprehensive framework for scientists to process raw meteorological data for analysis.

This repo contains all the software for the metobs_toolkit.

Documentation

Documentation can be found here.

The Documentation contains examples, explanations, and the API documentation of the toolkit. Make sure that the documentation version matches your version of the toolkit.

Installing the package

Install the package using pip:

pip install metobs-toolkit

To install the PyPi version of the toolkit. To install the github versions one can use these commands:

#main versions
pip install git+https://github.com/vergauwenthomas/MetObs_toolkit.git

#development version
pip install git+https://github.com/vergauwenthomas/MetObs_toolkit.git@dev

#specific release from github
pip install git+https://github.com/vergauwenthomas/[email protected]

For some advanced quality control methods, the Titanlib package is used. Since the installation of titanlib requires a c++ compiler, we have chosen not to include it in the toolkit. If you want to use the Titanlib functionality you must install both the toolkit and Titanlib:

pip install metobs-toolkit titanlib

To use the package, import it in Python:

import metobs_toolkit

#Check your version
metobs_toolkit.__version__

Exercises and demos

In the context of a FAIRNESS (COST action) summer school, a set of well-documented exercises and demos are made.

Notebook Description
Introduction Introduction to the toolkit Open In Colab
Quality control Introduction to quality control methods Open In Colab
Filling gaps Introduction to gap filling methods Open In Colab
Analysis Introduction analysis methods Open In Colab

*NOTE: * these exercises are built on an early version of the toolkit! We recommend using the examples in the documentation.

Related