imktk 0.1.8rc1

Toolkit provided by IMK at KIT

IMK Toolkit

This toolkit provides post-processing scripts developed by members of the Institute of Meteorology and Climate Research (IMK) at the Karlsruhe Institute of Technology (KIT). The goal of this module is to gather together python post-processing scripts for the analysis of netCDF data.

Getting Started

The easiest method to test the module before installation is to use the provided Dockerfile (together with Makefile).

Build the container

docker build --tag imktk/imktk .
# or
make container

Enter the container

docker run -it -v $(pwd)/imktk:/home/python/imktk imktk/imktk bash
# or
make bash

Changes to the repository are directly reflected within the container. Therefore, this method is recommended for development purposes. For details see CONTRIBUTING.md

Install

Choose one of the following methods to install the package:

1. Install using pip
2. Install using conda
3. Install straight from this repository using git clone

This package supports Python3 starting with version 3.7. If you are using an earlier version of Python please consider updating your system.

pip

Releases are automatically uploaded to PyPI. Please execute following command to install the package.

python3 -m pip install imktk

conda

Currently the package does no support native installation using conda respectively conda-forge. This feature is on the roadmap and you can follow its process using issue #34. The current workaround for conda installation is to use the following steps for any given environment <env>.

1. Activate the environment

conda activate <env>

2. Install using pip

python3 -m pip install imktk

git clone

It is also possible to install the package natively by cloning the repository. If you are interested in using this method of installation please follow these steps

1. Install build dependencies

python3 -m pip install build

2. Clone repository

git clone https://github.com/imk-toolkit/imk-toolkit.git

3. Generate the Python packages

python3 -m build
# or
make
# or
make build

4. Install packages

pip3 install dist/imktk-<current.version>-py3-none-any.whl
# or
make install

Please be aware that the package uses HDF5 and netCDF c-library in the backend. If you are installing using this method consider setting the HDF5_DIR environment variable with the location of the HDF5 header files.

Usage

import imktk
import xarray as xr

t = xr.tutorial.open_dataset("rasm").load().Tair
anomaly_free_t = t.imktk.anomalies()

Further reading

If you are interested in the inner workings of the package and details of the implementation please refer to the embedded README.md.