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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a696902b3047be9c30b0029d68f6607837a520e6003fb864bde5a68768566fe |
|
MD5 | 8748e192e0767b5cb8153d2df01900b6 |
|
BLAKE2b-256 | e82ea7881c8e9cdb8882baf821c7c568430add85631214f32eba230b19aa3a7d |
Close
Hashes for iterative_ensemble_smoother-0.2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 497124d94131caeb7d8c63a47f64b32675079e8d44bc3543167eec80ab9b5e7b |
|
MD5 | e05ff215bdac149c596e3c70bd15f081 |
|
BLAKE2b-256 | edeb14d665a80ba11be5b3fde091d4ee3efbbbf9d22d3386905c10a1489b9bd2 |