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

   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 general_config file (e.g. paths and site specifics) and set your retrieval specifications in the retrieval config files. Use config_tpb.yaml and the ret_specs.yaml for tpb retrievals.
2. run the routine

   py_make_retrieval/cli.py --ret RETRIEVAL

RETRIEVAL

• iwv: integrated water vapour
• lwp: liquid water path
• tbx: spectrum retrievals for spectral consistency checks
• hpt: absolute humidity profiles from single angle observations
• tpt: temperature profiles from single angle observations
• tpb: temperature profiles from multi angle observations (elevation scans)
• 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.

• Readme Template
• cloudnetpy GitHub
• mwrpy GitHub
• Jonas Witthuhn

(back to top)