Package: imktk
IMK ToolkitThis toolkit providespost-processing scriptsdeveloped by members of theInstitute 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
and distribute them easily.UsageSimply import the library usingimport imktk. From then on all scripts are
available using theimktkattribute:importimktkds=imktk.tutorial.open_dataset("toy_weather")# Load example datasetanomaly_free_tmin=ds.tmin.imktk.anomalies()# Select dataarray `xr.tmin` and execute anomalies scriptThe following is a list of available scripts:DescriptionExample usageLink to ScriptCalculate temperature for adiabatic process in airds.tmin.imktk.ad_temp(temp_at_0, press_at_0)hereCalculate monthly anomaliesds.tmin.imktk.anomalies()hereCalculate monthly climatologyds.tmin.imktk.climatology()hereInterpolation routine for flight track (incl. aircraft and satellites)ds.tmin.imktk.flight_track(**dims)hereCalculate number density from mixing ratio, temperature and pressureds.tmin.imktk.num_den(temp, press)hereCalculate saturation vapour pressure over ice for temperatures > 110 Kds.tmin.imktk.vapour_pres_ice()hereCalculate saturation vapour pressure over liquid water for temperatures 123 K < T < 332 Kds.tmin.imktk.vapour_pres_liq()hereGetting StartedThe easiest method to test the module is to use an interactive session with docker.
In this environment you will have a Python 3 environment with all necessary dependencies already installed.dockerrun-itimktk/imktk:latestbashFor the brave: You can test the latest release candidate by changinglatesttotestingInstallChoose one of the following methods to install the package:Install usingpipInstall usingcondaInstall usinggit cloneThis package supports only Python 3 with version>=3.7. If you are using
an earlier version of Python please consider updating.pipReleases are automatically uploaded to PyPI. Please execute following command
to install the package.python3-mpipinstallimktkcondaCurrently the package does no support native installation usingcondarespectivelyconda-forge. This feature is on the roadmap and you can follow
its process using issue#34.
The current workaround forcondainstallation is to use the following steps
for any given environment<env>.Activate the environmentcondaactivate<env>Install usingpippython3-mpipinstallimktkgit cloneIt 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 stepsInstall build dependenciespython3-mpipinstallbuildClone repositorygitclonehttps://github.com/imk-toolkit/imk-toolkit.gitGenerate the Python packagespython3-mbuild# or `make build`Install packagespip3installdist/imktk-<current.version>-py3-none-any.whl# or `make install`Please be aware that this package usesHDF5andnetCDFc-libraries in the
backend. If you are installing usinggit clonetheHDF5_DIRenvironment
variable with the location of the HDF5 header files needs to be set.Further readingIf you are interested in the inner workings of the package and details of the
implementation please refer to the embeddedREADME.md.