Metadata-Version: 2.1
Name: pyOptimalEstimation
Version: 1.1
Summary: UNKNOWN
Home-page: https://github.com/maahn/pyOptimalEstimation
Author: Maximilian Maahn
Author-email: maximilian.maahn@colorado.edu
License: GNU General Public License 3
Platform: UNKNOWN
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 :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: scipy

[![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://www.travis-ci.org/maahn/pyOptimalEstimation.svg?branch=master)](https://www.travis-ci.org/maahn/pyOptimalEstimation)
[![Coverage Status](https://coveralls.io/repos/github/maahn/pyOptimalEstimation/badge.svg?branch=master)](https://coveralls.io/github/maahn/pyOptimalEstimation?branch=master)

# "pyOptimalEstimation" Package v1.1

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

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

## Examples

Annotated example applications are available at https://github.com/maahn/pyOptimalEstimation_examples.

## API documentation

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




