A library for the iterative ensemble smoother algorithm.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for eivind.jahren from gravatar.com eivind.jahren Avatar for Equinor from gravatar.com Equinor

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v3 or later (GPLv3+) (GPL-3.0)
  • Author: Equinor
  • Maintainer: Eivind Jahren
  • Provides-Extra: doc , dev
Classifiers
Report project as malware

Project description

Iterative Ensemble Smoother

License: GPL v3 Stars Python PyPI Downloads Build Status Precommit: enabled Ruff Mypy Code style: black docs

About

iterative_ensemble_smoother is a Python library for data assimilation and history matching using ensemble-based methods. It implements efficient algorithms particularly effective for problems with a large number of parameters (e.g., millions) and relatively few realizations (e.g., hundreds).

The package provides two main algorithms:

  • ESMDA (Ensemble Smoother with Multiple Data Assimilation) - A non-iterative method with multiple data assimilation steps, described in Emerick & Reynolds 2013

The package also supports two methods of localization: correlation-based (AdaptiveESMDA) and distance-based (DistanceESMDA).

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 class ESMDA. Check out the examples section to see how to use it.

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

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for eivind.jahren from gravatar.com eivind.jahren Avatar for Equinor from gravatar.com Equinor

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v3 or later (GPLv3+) (GPL-3.0)
  • Author: Equinor
  • Maintainer: Eivind Jahren
  • Provides-Extra: doc , dev
Classifiers

Release history Release notifications | RSS feed

This version

1.2.0

1.1.0

1.0.0

0.6.0

0.5.1

0.5.0

0.4.2

0.4.1

0.4.0

0.3.0

0.2.7

0.2.6

0.2.5

0.2.5b0 pre-release

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.1

0.1.0

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

0.0.1b0 pre-release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iterative_ensemble_smoother-1.2.0.tar.gz (162.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iterative_ensemble_smoother-1.2.0-py3-none-any.whl (41.3 kB view details)

Uploaded Python 3

File details

Details for the file iterative_ensemble_smoother-1.2.0.tar.gz.

File metadata

File hashes

Hashes for iterative_ensemble_smoother-1.2.0.tar.gz
Algorithm Hash digest
SHA256 933fddeb3b355f128a57fd3698c837af202548b18acad46bd5b05e68da2501ad
MD5 c2e1373880ff5dfb5333c995c598aa2c
BLAKE2b-256 479a140d0e7d9bd419e741a0207cc44d90b05367fc9685b7037e79eaece92e70

See more details on using hashes here.

Provenance

The following attestation bundles were made for iterative_ensemble_smoother-1.2.0.tar.gz:

Publisher: upload_to_pypi.yml on equinor/iterative_ensemble_smoother

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file iterative_ensemble_smoother-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for iterative_ensemble_smoother-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2cf58e9713b6ddbd60df9e44e2277443fe8b3faddeff08c69fd26e89b61fbb69
MD5 f7badec6986697e9a36d70cdfb36a57b
BLAKE2b-256 94fd2b48babe3be7ddb10a2b6237215686c3293659d06fb62df24e2721af8010

See more details on using hashes here.

Provenance

The following attestation bundles were made for iterative_ensemble_smoother-1.2.0-py3-none-any.whl:

Publisher: upload_to_pypi.yml on equinor/iterative_ensemble_smoother

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page