Data

Tools

Indexes

Applications

Experiments

Open Source Science

pymakeretrieval

Make HATPRO microwave radiometer retrievals for LWP, IWV, TPT, HPT, TPB, TBX

https://github.com/remsens-lim/pymakeretrieval

Science Score: 67.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 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Make HATPRO microwave radiometer retrievals for LWP, IWV, TPT, HPT, TPB, TBX

Basic Info
  • Host: GitHub
  • Owner: remsens-lim
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 36.7 MB
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 1
  • Open Issues: 0
  • Releases: 11
Created over 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Contributing License Code of conduct Citation Zenodo

README.md

Python package Pylint DOI License: MIT Github all releases Open Source? Yes! Maintenance Twitter URL Mastodon Follow

pyMakeRetrieval

Generates microwave radiometer retrievals for LWP, IWV, TPT, HPT, TPB, TBX based on radiative transfer calculation data

Table of Contents
  1. Introduction
  2. Installation
  3. Usage
  4. Roadmap
  5. License
  6. Contact
  7. Acknowledgments

Introduction

This repository was created for generating microwave radiometer retrievals for LWP, IWV, TPT, HPT, TPB, TBX based on radiative transfer calculation data. The default settings in the config files are set for the microwave radiometer HATPRO from the german manufacturer Radiometer Physics GmbH.

Installation

Below is an example of how run the script, which reads in the radiative transfer data and makes the retrievals. This method relies on external dependencies such as xarray, numpy and others (see setup.py). The output are nc files which contains the coefficients and plots about the retrieval performance based on test data.

  1. install from github sh git clone https://github.com/remsens-lim/pyMakeRetrieval.git cd pyMakeRetrieval python3 -m venv venv source venv/bin/activate pip3 install --upgrade pip pip3 install .

(back to top)

Usage

  1. set your specifications in the generalconfig file (e.g. paths and site specifics) and set your retrieval specifications in the retrieval config files. Use configtpb.yaml and the ret_specs.yaml for tpb retrievals.
  2. run the routine sh py_make_retrieval/cli.py --ret RETRIEVAL RETRIEVAL
  3. iwv: integrated water vapour
  4. lwp: liquid water path
  5. tbx: spectrum retrievals for spectral consistency checks
  6. hpt: absolute humidity profiles from single angle observations
  7. tpt: temperature profiles from single angle observations
  8. tpb: temperature profiles from multi angle observations (elevation scans)
  9. all: makes all of the retrievals above

(back to top)

Roadmap

  • [ ] add meaningful docstrings
  • [ ] make documentation --> readthedocs
  • [ ] enable pip install ...
  • [ ] Add Tests

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Andreas Foth

(back to top)

Acknowledgments

Special thanks for templates and help during implementation.

(back to top)

Owner

  • Name: remsens-lim
  • Login: remsens-lim
  • Kind: user

Leipzig Institute for Meteorology Remote-Sensing and the Arctic Climate Systems

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Foth
    given-names: Andreas
    orcid: https://orcid.org/0000-0002-1164-3576
title: pyMakeRetrieval
version: v1.2.0
date-released: 2023-10-17

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Dependencies

.github/workflows/pylint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/python-package.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
pyproject.toml pypi