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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c2d63234c62ee311a55ac08cd2346fe6248331a8c64b972ad9ef2e3d9aeb75c |
|
MD5 | 5d57eb4a616ff8c61e7de78e397907e8 |
|
BLAKE2b-256 | fc9b47f5055b403b8d001cec8dc25561ec65067b015a09ad51a245603470fa90 |
Close
Hashes for iterative_ensemble_smoother-0.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d08b18f6cd0cba98daad2c45aa0b09cb7c9d3e9e7291bc2a43fd2b25cdb68f89 |
|
MD5 | dd80205991aca3948b9d8004aab2d005 |
|
BLAKE2b-256 | eacd37646bc9ded920371f705c4a5bbbcbad4aa753247bfdc08416b96420c9a9 |