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.5b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7578ff6e323d9912f5e0b5ed31a81f483b3003e41d04941cd426f767ed45ebea |
|
MD5 | 8c8d9b16afd224b0a9733c1f77eb5ead |
|
BLAKE2b-256 | 1404c7a2b26e8bffda1c4d742147725824a5c535b22630d3c608ea25d8a85277 |
Close
Hashes for iterative_ensemble_smoother-0.2.5b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 226a0a55dd0f4faae52c72ced1b86ca2e80e26176344e70ed97fde74face800c |
|
MD5 | 3d81b8c014ef114a42e9ebc920a21e01 |
|
BLAKE2b-256 | f724e3f9d339d2f712a7d1058af8fc9bc21766660d5f78ba68ac06e19f604e30 |