Metadata-Version: 2.1
Name: pyesmda
Version: 0.2.0
Summary: Python Ensemble Smoother with Multiple Data Assimilations
Home-page: https://gitlab.com/antoinecollet5/pyesmda
Author: Antoine Collet
Author-email: antoine.collet5@gmail.com
License: MIT license
Keywords: esmda,es-mda,inversion,inverse problem,parameter estimation,stochastic-optimization,ensemble smoother
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.6
License-File: LICENSE
License-File: AUTHORS.rst

=======
pyESMDA
=======


.. image:: https://gitlab.com/antoinecollet5/pyesmda/badges/master/pipeline.svg
    :target: https://gitlab.com/antoinecollet5/pyesmda/pipelines/
    :alt: Build Status

.. image:: https://img.shields.io/pypi/v/pyesmda.svg
    :target: https://pypi.org/pypi/pyesmda
    :alt: PyPI

.. image:: https://img.shields.io/pypi/pyversions/pyesmda.svg
    :target: https://pypi.org/pypi/pyesmda
    :alt: Python

.. image:: https://gitlab.com/antoinecollet5/pyesmda/badges/master/coverage.svg
    :target: https://gitlab.com/antoinecollet5/pyesmda/pipelines/
    :alt: Coverage

.. image:: https://app.codacy.com/project/badge/Grade/bc4d1a8a1f574273a053a32d44931c00    
    :target: https://www.codacy.com/gl/antoinecollet5/pyesmda/dashboard?utm_source=gitlab.com&amp;utm_medium=referral&amp;utm_content=antoinecollet5/pyesmda&amp;utm_campaign=Badge_Grade
    :alt: codacy
    
.. image:: https://readthedocs.org/projects/pyesmda/badge/?version=latest
    :target: https://pyesmda.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://img.shields.io/badge/License-MIT license-blue.svg
    :target: https://gitlab.com/antoinecollet5/pyesmda/-/blob/master/LICENSE

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
    :target: https://github.com/psf/black
    :alt: Black


Python Ensemble Smoother with Multiple Data Assimilations

This package is an object-oriented python implementation of the ES-MDA
algotithm based on the work of Emerick and Reynolds [1-2].

* Free software: MIT license
* Documentation: https://pyesmda.readthedocs.io.

The original python implementation was by Muhammad Iffan Hannanu
(https://github.com/iffanh/Playground).

References
----------

* [1] Emerick, A. A. and A. C. Reynolds, Ensemble smoother with multiple
  data assimilation, Computers & Geosciences, 2012.
* [2] Emerick, A. A. and A. C. Reynolds. (2013). History-Matching
  Production and Seismic Data in a Real Field Case Using the Ensemble
  Smoother With Multiple Data Assimilation. Society of Petroleum
  Engineers - SPE Reservoir Simulation Symposium
  1.    2. 10.2118/163675-MS.

==============
Changelog
==============

0.2.0 (2022-03-06)
------------------

* `!PR6 <https://gitlab.com/antoinecollet5/pyesmda/-/merge_requests/6>`_ The parameter `stdev_d` becomes `cov_d`.
* `!PR5 <https://gitlab.com/antoinecollet5/pyesmda/-/merge_requests/5>`_ The parameter `n_assimilation` becomes `n_assimilations`.
* `!PR4 <https://gitlab.com/antoinecollet5/pyesmda/-/merge_requests/4>`_ The parameter `stdev_m` is removed.
* `!PR3 <https://gitlab.com/antoinecollet5/pyesmda/-/merge_requests/3>`_ Type hints are now used in the library.
* `!PR2 <https://gitlab.com/antoinecollet5/pyesmda/-/merge_requests/2>`_ Add the possibility to save the history of m and d. This introduces a new knew
  keyword (boolean) for the constructor `save_ensembles_history`. 
  Note that the `m_mean` attribute is depreciated and two new attributes are 
  introduced: `m_history`, `d_history` respectively to access the successive
  parameter and predictions ensemble. 


0.1.0 (2021-11-28)
------------------

* First release on PyPI.


