Metadata-Version: 2.1
Name: pyOptimalEstimation
Version: 1.3
Home-page: https://github.com/maahn/pyOptimalEstimation
Author: Maximilian Maahn
License: GNU General Public License 3
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: scipy
Requires-Dist: importlib-metadata

[![PyPI version](https://badge.fury.io/py/pyOptimalEstimation.svg)](https://badge.fury.io/py/pyOptimalEstimation)
[![Documentation Status](https://readthedocs.org/projects/pyoptimalestimation/badge/?version=latest)](https://pyoptimalestimation.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://github.com/maahn/pyOptimalEstimation/actions/workflows/github-actions-ci.yaml/badge.svg)](https://github.com/maahn/pyOptimalEstimation/actions/workflows/github-actions-ci.yaml)
[![Coverage Status](https://coveralls.io/repos/github/maahn/pyOptimalEstimation/badge.svg?branch=master)](https://coveralls.io/github/maahn/pyOptimalEstimation?branch=master)
[![Downloads](https://pepy.tech/badge/pyoptimalestimation)](https://pepy.tech/project/pyoptimalestimation)

# "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.

