Skip to content

equinor/iterative_ensemble_smoother

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date
Sep 28, 2023
Oct 20, 2023
Oct 20, 2023
Oct 18, 2023
Oct 20, 2023
Jan 5, 2023
Oct 3, 2023
Sep 19, 2023
Aug 18, 2022
Oct 20, 2023
Oct 20, 2023
Oct 3, 2023
Sep 28, 2023

Repository files navigation

Iterative Ensemble Smoother

License: GPL v3 Stars Python PyPI Downloads Build Status Precommit: enabled Ruff Mypy Code style: black docs

About

iterative_ensemble_smoother is a Python package that implements the subspace iterative ensemble smoother as described in evensen2019. This algorithm is particularly effective for problems with a large number of parameters (e.g., millions) and a few realizations or samples (e.g., hundreds).

Installation

iterative_ensemble_smoother is on PyPi and can be installed using pip:

pip install iterative_ensemble_smoother

Usage

iterative_ensemble_smoother mainly implements SIES and ESMDA classes. Check out the examples section to see how to use them.

Building from source

To build iterative_ensemble_smoother from source:

git clone https://github.com/equinor/iterative_ensemble_smoother.git
cd iterative_ensemble_smoother
pip install .

Building the documentation

apt install pandoc # Pandoc is required to build the documentation.
pip install .[doc]
sphinx-build -c docs/source/ -b html docs/source/ docs/build/html/