MWRpy

A Python software to process RPG Microwave Radiometer data and is developed at the University of Cologne, Germany as part of the Aerosol, Clouds and Trace Gases Research Infrastructure (ACTRIS).
https://github.com/actris-cloudnet/mwrpy

Category: Atmosphere
Sub Category: Atmospheric Composition and Dynamics

Last synced: about 19 hours ago
JSON representation

Repository metadata

Python package for Microwave Radiometer processing in ACTRIS

README.md

MWRpy

MWRpy tests
PyPI version
DOI
paper

MWRpy is a Python software to process RPG Microwave Radiometer data and is developed
at the University of Cologne, Germany as part
of the Aerosol, Clouds and Trace Gases Research Infrastructure (ACTRIS).

The software features reading raw data, Level 1 quality control, generation of
Level 2 data products and visualization and is based on the IDL code
mwr_pro.

The netCDF data format including metadata information, variable names and file naming
is designed to be compliant with either the data structure and naming convention
developed in the EUMETNET Profiling Programme E-PROFILE, or within ACTRIS Cloudnet.

MWRpy documentation: https://actris-cloudnet.github.io/mwrpy/

MWRpy example output

Citing

If you wish to acknowledge MWRpy in your publication, please cite:

Marke et al., (2024). MWRpy: A Python package for processing microwave radiometer data. Journal of Open Source
Software, 9(98), 6733, https://doi.org/10.21105/joss.06733

Installation

From PyPI:

python3 -m pip install mwrpy

From GitHub:

git clone https://github.com/actris-cloudnet/mwrpy.git
cd mwrpy
python3 -m venv venv
source venv/bin/activate
pip3 install --upgrade pip
pip3 install .

MWRpy requires Python 3.11 or newer.

Configuration

The folder mwrpy/site_config/ contains mandatory configuration files for each instrument
type, which also define the input and output data paths, metadata, etc.
For example, this is the configuration file for RPG-HATPRO.

The folders for each site, e.g. mwrpy/site_config/hyytiala/, contain a folder with the required retrieval coefficients
(mwrpy/site_config/hyytiala/coefficients/) and an optional site and instrument specific configuration file
(config.yaml). For example, this is the configuration file for Hyytiälä, which can
help with configuring multiple instruments of the same type.

When MWRpy is used as a Python library, a site configuration in the repository is not required: the site
information and the retrieval coefficient files can be passed directly to the processing functions. See the
documentation for examples.

Command line usage

MWRpy can be run using the command line tool python -m mwrpy.cli:

usage: python -m mwrpy.cli [-h] -s SITE [-d YYYY-MM-DD] [--start YYYY-MM-DD]
                           [--stop YYYY-MM-DD] [-p PRODUCTS] [-f FORMAT]
                           [-i INSTRUMENT] [{process,plot,no-plot,reprocess}]

Arguments:

Short Long Default Description
-h --help Show help and exit.
-s --site Site to process data from, e.g, hyytiala. Required.
-d --date Single date to be processed. Alternatively, --start and --stop can be defined.
--start current day - 1 Starting date (included).
--stop current day + 1 Stopping date (excluded).
-p --products 1C01, single, multi Processed products, e.g, 1C01, 2I02, 2P03, single, see below.
-f --format cloudnet Data format to be used (cloudnet, e-profile).
-i --instrument hatpro Instrument type to be processed (hatpro, lhatpro, lhumpro_u90).

Commands:

Command Description
process Process data and generate plots (default).
plot Only generate plots.
no-plot Only generate products.
reprocess Like process, but skips days when data processing fails.

Data types

Level 1

  • 1B01: MWR brightness temperatures from .BRT and .BLB/.BLS files + retrieved spectrum
  • 1B11: IR brightness temperatures from .IRT files
  • 1B21: Weather station data from .MET files
  • 1C01: Combined data type with time corresponding to 1B01

Level 2

  • 2I01: Liquid water path (LWP)
  • 2I02: Integrated water vapor (IWV)
  • 2I06: Stability Indices
  • 2P01: Temperature profiles from single-pointing observations
  • 2P02: Temperature profiles from multiple-pointing observations
  • 2P03: Absolute humidity profiles
  • 2P04: Relative humidity profiles (derived from 2P01/2P02 + 2P03)
  • 2P07: Potential temperature (derived from 2P01/2P02 + 2P03)
  • 2P08: Equivalent potential temperature (derived from 2P01/2P02 + 2P03)
  • single: Single pointing data product (including 2I01, 2I02, 2I06, 2P01, 2P03, and derived products)
  • multi: Multiple pointing data product (including 2P02, and derived products)

For the lhumpro_u90 instrument type, the single product includes 2I01, 2I02, and 2P03 only.

Only the 1C01, single, and multi data types are available when using the Cloudnet file format.

Licence

MIT

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
  - family-names: Marke
    given-names: Tobias
    orcid: "https://orcid.org/0000-0001-7804-9056"
  - family-names: Löhnert
    given-names: Ulrich
    orcid: "https://orcid.org/0000-0002-9023-0269"
  - family-names: Tukiainen
    given-names: Simo
    orcid: "https://orcid.org/0000-0002-0651-4622"
  - family-names: Siipola
    given-names: Tuomas
    orcid: "https://orcid.org/0009-0004-7757-0893"
  - family-names: Pospichal
    given-names: Bernhard
    orcid: "https://orcid.org/0000-0001-9517-8300"
contact:
  - family-names: Marke
    given-names: Tobias
    orcid: "https://orcid.org/0000-0001-7804-9056"
doi: 10.5281/zenodo.11614185
repository-code: "https://github.com/actris-cloudnet/mwrpy"
abstract: >-
  MWRpy is a Python code to process Microwave Radiometer observations. The software produces files for quality
  controlled brightness temperatures, vertical profiles of atmospheric temperature and humidity, and the total
  column-integrated water vapor and cloud liquid water.
keywords:
  - Python
  - meteorology
  - remote sensing
  - microwave radiometer
license: MIT
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
    - family-names: Marke
      given-names: Tobias
      orcid: "https://orcid.org/0000-0001-7804-9056"
    - family-names: Löhnert
      given-names: Ulrich
      orcid: "https://orcid.org/0000-0002-9023-0269"
    - family-names: Tukiainen
      given-names: Simo
      orcid: "https://orcid.org/0000-0002-0651-4622"
    - family-names: Siipola
      given-names: Tuomas
      orcid: "https://orcid.org/0009-0004-7757-0893"
    - family-names: Pospichal
      given-names: Bernhard
      orcid: "https://orcid.org/0000-0001-9517-8300"
  date-published: 2024-06-20
  doi: 10.21105/joss.06733
  issn: 2475-9066
  issue: 98
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6733
  title: "MWRpy: A Python package for processing microwave radiometer
    data"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06733"
  volume: 9
title: "MWRpy: A Python package for processing microwave radiometer
  data"

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 2 days ago

Total Commits: 434
Total Committers: 5
Avg Commits per committer: 86.8
Development Distribution Score (DDS): 0.606

Commits in past year: 38
Committers in past year: 4
Avg Commits per committer in past year: 9.5
Development Distribution Score (DDS) in past year: 0.658

Name Email Commits
tobiasmarke t****e@m****e 171
Simo Tukiainen s****n@f****i 159
Tuomas Siipola t****a@f****i 98
tobiasmarke t****e@u****e 5
Mengqi Zhao m****z@u****u 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 0
Total pull requests: 51
Average time to close issues: N/A
Average time to close pull requests: 8 days
Total issue authors: 0
Total pull request authors: 4
Average comments per issue: 0
Average comments per pull request: 0.22
Merged pull request: 44
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 4
Past year average time to close issues: N/A
Past year average time to close pull requests: 2 months
Past year issue authors: 0
Past year pull request authors: 2
Past year average comments per issue: 0
Past year average comments per pull request: 0.25
Past year merged pull request: 3
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/actris-cloudnet/mwrpy

Top Issue Authors

Top Pull Request Authors

  • tobiasmarke (37)
  • tukiains (8)
  • siiptuo (4)
  • mengqi-z (2)

Top Issue Labels

Top Pull Request Labels


Package metadata

pypi.org: mwrpy

Python package for Microwave Radiometer processing in ACTRIS

  • Homepage: https://github.com/actris-cloudnet/mwrpy
  • Documentation: https://actris-cloudnet.github.io/mwrpy/
  • Licenses: MIT License
  • Latest release: 1.7.3 (published 4 days ago)
  • Last Synced: 2026-10-23T07:03:32.062Z (2 days ago)
  • Versions: 63
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 1,421 Last month
  • Rankings:
    • Dependent packages count: 4.759%
    • Downloads: 10.017%
    • Average: 18.178%
    • Dependent repos count: 21.62%
    • Forks count: 22.613%
    • Stargazers count: 31.883%
  • Maintainers (3)

Dependencies

docs/requirements.txt pypi
  • sphinx ==7.2.6
  • sphinx-rtd-theme ==2.0.0
.github/workflows/docs.yaml actions
  • actions/checkout v6 composite
  • actions/deploy-pages v4 composite
  • actions/setup-python v6 composite
  • actions/upload-pages-artifact v3 composite
.github/workflows/publish.yml actions
  • actions/checkout v6 composite
  • actions/setup-python v6 composite
  • pypa/gh-action-pypi-publish release/v1 composite
  • softprops/action-gh-release v2 composite
pyproject.toml pypi
  • matplotlib *
  • metpy *
  • netcdf4 *
  • pandas *
  • pytz *
  • pyyaml *
  • scipy *
  • suncalc *
  • timezonefinder *
.github/workflows/test.yml actions
  • actions/checkout v6 composite
  • actions/setup-python v6 composite

Score: 11.269961786206713