MWRpy

MWRpy: A Python package for processing microwave radiometer data - Published in JOSS (2024)

https://github.com/actris-cloudnet/mwrpy

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
    2 of 4 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 4 months ago · JSON representation ·

Repository

Python package for Microwave Radiometer processing in ACTRIS

Basic Info
  • Host: GitHub
  • Owner: actris-cloudnet
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 8.08 MB
Statistics
  • Stars: 6
  • Watchers: 5
  • Forks: 5
  • Open Issues: 0
  • Releases: 52
Created almost 3 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing License Citation

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 the data structure and naming convention developed in the EUMETNET Profiling Programme E-PROFILE.

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:

shell python3 -m pip install mwrpy

From GitHub:

shell 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.10 or newer.

Configuration

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

The folders for each site, e.g. mwrpy/site_config/hyytiala/, contain a site and instrument specific configuration file (config.yaml) and retrieval coefficients. For example, this is the configuration file for Hyytiälä.

Command line usage

MWRpy can be run using the command line tool mwrpy/cli.py:

usage: mwrpy/cli.py [-h] -s SITE [-d YYYY-MM-DD] [--start YYYY-MM-DD]
                       [--stop YYYY-MM-DD] [-p ...] [{process,plot}]

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. | | | --stop | current day | Stopping date. | | -p | --products | 1C01, single, multi | Processed products, e.g, 1C01, 2I02, 2P03, single, see below. |

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)

Licence

MIT

Owner

  • Name: ACTRIS Cloudnet
  • Login: actris-cloudnet
  • Kind: organization
  • Email: actris-cloudnet@fmi.fi
  • Location: Helsinki, Finland

ACTRIS Cloud Remote Sensing Unit (CLU)

JOSS Publication

MWRpy: A Python package for processing microwave radiometer data
Published
June 20, 2024
Volume 9, Issue 98, Page 6733
Authors
Tobias Marke ORCID
Institute for Geophysics and Meteorology, University of Cologne, Germany
Ulrich Löhnert ORCID
Institute for Geophysics and Meteorology, University of Cologne, Germany
Simo Tukiainen ORCID
Finnish Meteorological Institute, Helsinki, Finland
Tuomas Siipola ORCID
Finnish Meteorological Institute, Helsinki, Finland
Bernhard Pospichal ORCID
Institute for Geophysics and Meteorology, University of Cologne, Germany
Editor
Mengqi Zhao ORCID
Tags
meteorology remote sensing microwave radiometer

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"

GitHub Events

Total
  • Release event: 14
  • Watch event: 4
  • Delete event: 15
  • Issue comment event: 1
  • Push event: 74
  • Pull request review comment event: 6
  • Pull request review event: 12
  • Pull request event: 17
  • Create event: 25
Last Year
  • Release event: 14
  • Watch event: 4
  • Delete event: 15
  • Issue comment event: 1
  • Push event: 74
  • Pull request review comment event: 6
  • Pull request review event: 12
  • Pull request event: 17
  • Create event: 25

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 383
  • Total Committers: 4
  • Avg Commits per committer: 95.75
  • Development Distribution Score (DDS): 0.587
Past Year
  • Commits: 118
  • Committers: 3
  • Avg Commits per committer: 39.333
  • Development Distribution Score (DDS): 0.415
Top Committers
Name Email Commits
tobiasmarke t****e@m****e 158
Simo Tukiainen s****n@f****i 143
Tuomas Siipola t****a@f****i 81
Mengqi Zhao m****z@u****u 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 31
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 days
  • Total issue authors: 0
  • Total pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.23
  • Merged pull requests: 27
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 13
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 days
  • Issue authors: 0
  • Pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.08
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • tobiasmarke (34)
  • tukiains (7)
  • siiptuo (4)
  • mengqi-z (2)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,545 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 51
  • Total maintainers: 3
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/
  • License: MIT License Copyright (c) 2021-2023 University of Cologne Copyright (c) 2023 Finnish Meteorological Institute Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 1.3.5
    published 4 months ago
  • Versions: 51
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 1,545 Last month
Rankings
Dependent packages count: 4.8%
Downloads: 10.0%
Average: 18.2%
Dependent repos count: 21.6%
Forks count: 22.6%
Stargazers count: 31.9%
Maintainers (3)
Last synced: 4 months ago