Skip to main content
https://github.com/GeoMop/MLMC/workflows/package/badge.svg https://img.shields.io/pypi/v/mlmc.svg https://img.shields.io/pypi/pyversions/mlmc.svg https://img.shields.io/badge/License-GPLv3-blue.svg

MLMC is a Python library implementing the Multilevel Monte Carlo (MLMC) method. It provides tools for sampling, moment estimation, statistical post-processing, and more.

Originally developed as part of the GeoMop project.

Features

  • Sample scheduling

  • Estimation of generalized moments

  • Advanced post-processing with the Quantity structure

  • Approximation of probability density functions using the maximum entropy method

  • Bootstrap and regression-based variance estimation

  • Diagnostic tools (e.g., consistency checks)

Installation

The package is available on PyPI and can be installed with pip:

pip install mlmc

To install the latest development version:

git clone https://github.com/GeoMop/MLMC.git
cd MLMC
pip install -e .

Documentation

Full documentation, including tutorials, is available at: https://mlmc.readthedocs.io/

Topics covered include:

  • Basic MLMC workflow and examples

  • Definition and composition of Quantity objects

  • Moment and covariance estimation

  • Probability density function reconstruction

Development

Contributions are welcome! To contribute, please fork the repository and create a pull request.

Before submitting, make sure all tests pass by running tox:

pip install tox
tox

tox creates a clean virtual environment, installs all dependencies, runs unit tests via pytest, and checks that the package installs correctly.

Requirements

MLMC depends on the following Python packages:

License

  • Free software: GNU General Public License v3.0

Release files for mlmc 1.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mlmc 1.0.3
File Size Uploaded
mlmc-1.0.3.tar.gz 128.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mlmc 1.0.3
File Interpreter ABI Platform
mlmc-1.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 241.8 kB

Release files / mlmc-1.0.3.tar.gz

Download URL mlmc-1.0.3.tar.gz
Size 128.6 kB
Tags Source
SHA-256 checksum
How to use checksums
afda9b7954ac7f296232af633e0592b5f1965a557c0127588e50569b2b3b9d41
BLAKE2b-256 checksum
How to use checksums
8a7a989a0d3b3d966d69eccb9ab2fac284455329e11f8c3589e1baedba48312f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.1

Release files / mlmc-1.0.3-py3-none-any.whl

Download URL mlmc-1.0.3-py3-none-any.whl
Size 113.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
60d256e14d3413ebe7dac74a79612f9881350533d2855367eedc4234da5e384a
BLAKE2b-256 checksum
How to use checksums
a74c4aa1e810ef953408cfa11463d57ec3727b2b6074f7e6444e50409649b1bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.1

Release history Release notifications | RSS feed

This release

1.0.3 This release

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page