A library for the iterative ensemble smoother algorithm.
Project description
Iterative Ensemble Smoother
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
If you want to do development, then run:
git clone https://github.com/equinor/iterative_ensemble_smoother.git
cd iterative_ensemble_smoother
<create environment>
pip install --editable '.[doc,dev]'
Usage
iterative_ensemble_smoother mainly implements the two classes SIES
and ESMDA
.
Check out the examples section to see how to use them.
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/
Releasing a new version
- Create a tag, e.g.
git tag -a v1.0.0 -m "A short note" cf2c87270d3
locally on the commit. - Push the tag, e.g.
git push upstream v1.0.0
. - Create a release on the GitHub GUI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for iterative_ensemble_smoother-0.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec15c1dba268c880a7da6e2460c6fec784cbda0cf958b8cbeb2094ae8d1f49c4 |
|
MD5 | b643729b4b6ebb5ab445a8aff54e638d |
|
BLAKE2b-256 | 0f690a7dd0808ced601ee5373d677dc0700171918fbf06b1476b136e98a6a9ce |
Close
Hashes for iterative_ensemble_smoother-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d757ce7c247003d366ddb825c8ae3f9272f7e8769ae8ecdb894d1d058e535d6 |
|
MD5 | 0a809c8f2921b29f40b575bcb10d1a8c |
|
BLAKE2b-256 | 2cd7bab3aec071d4de9a95976657d27104459d4e154e46619652516330e81d13 |