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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02a80c2e16c0fbb3d804f6672ba9ae6d13a06b5103d7623a83ab66e07f88fccd |
|
MD5 | 408e209d3daebba72816fe262e13dd87 |
|
BLAKE2b-256 | 9a4d9d7643b8af219cde7ab282d95453d61d75e393550307b1a8aa2b051cb444 |
Close
Hashes for iterative_ensemble_smoother-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf983ea1d89f7ebcb887024c578650e4d1968ebf943ff624262203b94fe66ac4 |
|
MD5 | e18680fa7fea49a992f7a3b197e73581 |
|
BLAKE2b-256 | bc0d4ba492ad6cdb5d8ee1c432b3c4fb180918d4ea2c9c5330fa415c96245cc3 |