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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44681df4e8a2d7d98ee715af40bfdbca6fa811ac75842d0c65598b9270e3f37f |
|
MD5 | a141c1ebb53830b589782b6bfbac000f |
|
BLAKE2b-256 | 35b33761650eccb3225df96bce7544f044a3f2ebfb7b38f6dbc9cb51f5705e68 |
Close
Hashes for iterative_ensemble_smoother-0.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7513811582f47682ed0eb23f5ab65739dd763a4626856264fe2d17b5f77f93b5 |
|
MD5 | 2bc5cd3a322ef3392fa26fc51b780a77 |
|
BLAKE2b-256 | d5ad47152fcab278e320850345f55ef3eb49aef31d9f27b0d6b221933636a722 |