st-bender / pymipas_noxy

PyMIPAS_NOxy

MIPAS NOx/NOy calculator tools

Some tools to handle MIPAS level-2 netCDF files, and to combine trace gas species to calculate NOx (= NO + NO2) and NOy (= NO + NO2 + ClONO2 + N2O5 + HNO3 + HNO4) from the single species.

⚠️ This package is in alpha stage, that is, it works mostly, but the interface might still be subject to change.

Install

Requirements

• numpy - required
• xarray - required for reading netCDF files
• h5netcdf - required for reading netCDF files
• scipy - required for the interpolation interface
• click - required for the command line interface
• toml - required to read the configuration files
• pytest - optional, for testing

mipas_noxy

An installable pip package called mipas_noxy will soon be available from the main package repository, it can then be installed with:

$ pip install mipas_noxy

The latest development version can be installed with pip directly from github (see https://pip.pypa.io/en/stable/reference/pip_install/#vcs-support and https://pip.pypa.io/en/stable/reference/pip_install/#git):

$ pip install [-e] git+https://github.com/st-bender/pymipas_noxy.git

The other option is to use a local clone:

$ git clone https://github.com/st-bender/pymipas_noxy.git
$ cd pymipas_noxy

and then using pip (optionally using -e, see https://pip.pypa.io/en/stable/reference/pip_install/#install-editable):

$ pip install [-e] .

or using setup.py:

$ python setup.py install

Optionally, test the correct function of the module with

$ py.test [-v]

or even including the doctests in this document:

$ py.test [-v] --doctest-glob='*.md'

Usage

The python module itself is named mipas_noxy and is imported as usual.

All functions should be numpy-compatible and work with scalars and appropriately shaped arrays.

>>> import mipas_noxy as moxy

Opening MIPAS level-2 netcdf files

The MIPAS level-2 netcdf files contain 2-D altitude coordinates which xarray can currently not deal with nicely. This module provide a convenience function to read those files:

>>> from mipas_noxy import open_mipas_l2
>>> open_mipas_l2("/path/to/mipas-level2-file.nc")

It also contains one that can combine multiple files into one data set, taking a glob-string or list of files:

>>> from mipas_noxy import open_mfmipas_l2
>>> open_mfmipas_l2("/path/to/mipas-level2-files*.nc")

Command line interface

A command line interface to combine different species to "NOx" or "NOy" (and possibly others) is available as mipas_noxy <args>, or using python's -m switch as python -m mipas_noxy <args>. The argument is basically the configuration file for processing, more command line options are listed by passing -h or --help: mipas_noxy -h. The processing is configured through a toml file, currently available options are described in the example configuration file.

Basic class and method documentation is accessible via pydoc:

$ pydoc mipas_noxy

License

This python interface is free software: you can redistribute it or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2 (GPLv2), see local copy or online version.