"pyOptimalEstimation" Package

Python package to solve an inverse problem using Optimal Estimation and an arbitrary Forward model following Rodgers, 2000.

Tested with Python >=3.6. The last version supporting Python 2.7 was 1.1

Installation

Change to the folder containing the project and do

  python setup.py install

in the terminal. If you do not have root privileges, you can also do:

  python setup.py --user install

which will install pyOptimalEstimation in userbase/lib/pythonX.Y/site-packages or

  python setup.py install --home=~

which will install pyOptimalEstimation in ~/lib/python.

Reference

Please reference to our paper if you use the pyOptimalEstimation package

Maahn, M., D. D. Turner, U. Löhnert, D. J. Posselt, K. Ebell, G. G. Mace, and J. M. Comstock, 2020: Optimal Estimation Retrievals and Their Uncertainties: What Every Atmospheric Scientist Should Know. Bull. Amer. Meteor. Soc., doi:https://doi.org/10.1175/BAMS-D-19-0027.1

Examples

• A minimal working example can be found at https://github.com/maahn/pyOptimalEstimation/blob/master/pyOptimalEstimation/examples/dsd_radar.py
• Two fullly annotated examples (microwave temperature/humidity retrieval & radar drops size distribution retrieval) are available at https://github.com/maahn/pyOptimalEstimation_examples. They can be run online using binder.
• A retrieval for retrieving surface winds from satellites using RTTOV is available at https://github.com/deweatherman/RadEst

API documentation

See https://pyoptimalestimation.readthedocs.io/en/latest/ for documentation.