Metadata-Version: 2.1
Name: fmu-ensemble
Version: 1.6.3
Summary: Python API to ensembles produced by ERT
Home-page: https://github.com/equinor/fmu-ensemble
Author: Håvard Berland
Author-email: havb@equinor.com
License: GPLv3
Keywords: fmu,ensemble
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8
Provides-Extra: tests
Provides-Extra: docs
Provides-Extra: parquet
License-File: LICENSE
License-File: AUTHORS.rst

.. image:: https://badge.fury.io/py/fmu-ensemble.svg
    :target: https://badge.fury.io/py/fmu-ensemble

.. image:: https://img.shields.io/github/workflow/status/equinor/fmu-ensemble/fmu-ensemble
    :target: https://github.com/equinor/fmu-ensemble/actions?query=workflow%3Afmu-ensemble

.. image:: https://img.shields.io/lgtm/alerts/g/equinor/fmu-ensemble.svg?logo=lgtm&logoWidth=18
    :target: https://lgtm.com/projects/g/equinor/fmu-ensemble/alerts/

.. image:: https://codecov.io/gh/equinor/fmu-ensemble/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/equinor/fmu-ensemble

.. image:: https://img.shields.io/lgtm/grade/python/g/equinor/fmu-ensemble.svg?logo=lgtm&logoWidth=18
    :target: https://lgtm.com/projects/g/equinor/fmu-ensemble/context:python

.. image:: https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10-blue.svg
    :target: https://www.python.org

==============================
Introduction to *fmu.ensemble*
==============================

FMU Ensemble is a Python module for handling simulation ensembles
originating from an FMU (Fast Model Update) workflow.

For documentation, see the
`github pages for this repository <https://equinor.github.io/fmu-ensemble/>`_.

Ensembles consist of realizations. Realizations consist of (input and)
output from their associated *jobs* stored in text or binary files.
Selected file formats (text and binary) are supported.

This module will help you handle ensembles and realizations (and their
associated data) as Python objects, and thereby facilitating the use
use of other Python visualizations modules like webviz, plotly or
interactive usage in IPython/Jupyter.

If run as a post-workflow in Ert, a simple script using this library
can replace and extend the existing *CSV_EXPORT1* workflow

This software is released under GPL v3.0


=======
History
=======

Commit history
--------------

See commit log on github, https://github.com/equinor/fmu-ensemble/commits/

First open release (GPLv3) in June 2019.

Prior work
----------

The fmu.ensemble Python module development was started in August 2018,
as an Equinor internal code project, building prior internal
work from at leastL:

* Smørbukk Sør webportal
* Post-processing library made for webportal (2017/2018) https://github.com/Statoil/fmu_postprocessing
* PyPostFMU https://git.equinor.com/FDIL/pypostfmu


