mHM - Python bindings

[TOC]

Python bindings to control mHM.

The wrapper (mhm/wrapper.f90) is just a small layer on top of the interfaces provided by mHM to be compatible with f2py.

Installation

There is a PyPI package to install the latest release:

pip install mhm

Installing the mHM Python package will provide the mhm command to execute mHM the traditional way.

In order to compile the Python bindings from scratch you need:

Python with version at least v3.8 and pip
a Fortran, a C and a C++ compiler (set the environment variables FC (and F77), CC and CXX accordingly). In case of gcc, this could look like:
```
export FC="gfortran"
export F77="gfortran"
export CC="gcc"
export CXX="g++"
```
NetCDF-C installed in your system path

See the Compilation instructions for these dependencies.

You can also use a conda environment (set up with miniforge for example) to get everything:

conda install -y pip libnetcdf fortran-compiler c-compiler cxx-compiler

To compile everything after cloning/downloading, you can use pip:

pip install -v .

To install it directly from the git repository you can type:

pip install -v git+https://git.ufz.de/mhm/mhm.git

Environment variables

The following environment variables can be used to control the compilation and installation of the python bindings for mHM:

SKBUILD_CMAKE_BUILD_TYPE=[Release|Debug]: build type for the mhm library (default: Release)
MHM_BUILD_FORCES_PATH=<path>: custom path to forces source dir (default: None)
MHM_BUILD_PARALLEL=[0|1]: default value for CMAKE_WITH_OpenMP when building mHM (default: 0)
CMAKE_ARGS="<args>": additional CMake defines, for example -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_WITH_OpenMP=ON -DMHM_ENABLE_NATIVE=ON

Test domain download tool

Together with the Python bindings comes a command line script to download the test domains:

mhm-download --verbose --branch main --domain 1 --path mhm_domain/

To ensure the downloader is executed from the active Python environment, it can also be called as a module:

python -m mhm.download --domain 1 --path mhm_domain/

By default, the downloader first uses git.ufz and falls back to the github mirror. Use --source git.ufz or --source github to select a single source.

You can then run mHM on this test domain with:

mhm mhm_domain/

You can get help on how to use this script with mhm-download -h:

$ mhm-download -h
usage: mhm-download [-h] [-V] [-v] [-b BRANCH] [-d {1,2}] [-p PATH]
                    [-s {auto,git.ufz,github}]

Download tool to retrieve the test domains for mHM.

optional arguments:
  -h, --help            show this help message and exit
  -V, --version         display version information
  -v, --verbose         be verbose (default: False)
  -b BRANCH, --branch BRANCH
                        branch, tag, or commit of the mHM repository to take the test domain from,
                        by default tag determined from the mHM version (default: None)
  -d {1,2}, --domain {1,2}
                        test domain '1' or '2' (default: 1)
  -p PATH, --path PATH  destination path for the downloaded folder,
                        by default the original folder name in the current directory (default: None)
  -s {auto,git.ufz,github}, --source {auto,git.ufz,github}
                        download source; 'auto' tries git.ufz first and then github
                        (default: auto)

Within Python scripts, use mhm.download_test. Its source argument accepts the same auto, git.ufz, and github values. See below for examples.

Documentation

See mhm.tools and wrapper.f90 for further information on the provided routines.

Examples

If you have cloned the repository, you can do the following to simply run mhm without optimization:

import mhm

# download test domain 1
mhm.download_test(path="example_domain", source="auto")
# run the downloaded example
mhm.model.init(cwd="example_domain")
mhm.model.run()
mhm.model.finalize()

Or you can do the following to control each timestep:

import mhm

# assuming to run from the mhm repo root
mhm.model.init()
mhm.run.prepare()
ndomians = mhm.run.get_ndomains()
for i in range(1, ndomians + 1):
    mhm.run.prepare_domain(domain=i) # 0 by default
    while not mhm.run.finished():
        mhm.run.do_time_step()
        mhm.run.write_output()
    mhm.run.finalize_domain()
mhm.run.finalize()
mhm.model.finalize()

License

Download files

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

Source Distribution

mhm-5.13.4.tar.gz (921.4 kB view details)

Uploaded Jul 29, 2026 Source

Built Distributions

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

mhm-5.13.4-cp314-cp314-win_arm64.whl (4.2 MB view details)

Uploaded Jul 29, 2026 CPython 3.14Windows ARM64

mhm-5.13.4-cp314-cp314-win_amd64.whl (7.0 MB view details)

Uploaded Jul 29, 2026 CPython 3.14Windows x86-64

mhm-5.13.4-cp314-cp314-manylinux_2_28_x86_64.whl (5.9 MB view details)

Uploaded Jul 29, 2026 CPython 3.14manylinux: glibc 2.28+ x86-64

mhm-5.13.4-cp314-cp314-manylinux_2_28_aarch64.whl (5.1 MB view details)

Uploaded Jul 29, 2026 CPython 3.14manylinux: glibc 2.28+ ARM64

mhm-5.13.4-cp314-cp314-macosx_11_0_x86_64.whl (6.0 MB view details)

Uploaded Jul 29, 2026 CPython 3.14macOS 11.0+ x86-64

mhm-5.13.4-cp314-cp314-macosx_11_0_arm64.whl (4.7 MB view details)

Uploaded Jul 29, 2026 CPython 3.14macOS 11.0+ ARM64

mhm-5.13.4-cp313-cp313-win_arm64.whl (4.1 MB view details)

Uploaded Jul 29, 2026 CPython 3.13Windows ARM64

mhm-5.13.4-cp313-cp313-win_amd64.whl (6.9 MB view details)

Uploaded Jul 29, 2026 CPython 3.13Windows x86-64

mhm-5.13.4-cp313-cp313-manylinux_2_28_x86_64.whl (5.9 MB view details)

Uploaded Jul 29, 2026 CPython 3.13manylinux: glibc 2.28+ x86-64

mhm-5.13.4-cp313-cp313-manylinux_2_28_aarch64.whl (5.1 MB view details)

Uploaded Jul 29, 2026 CPython 3.13manylinux: glibc 2.28+ ARM64

mhm-5.13.4-cp313-cp313-macosx_11_0_x86_64.whl (6.0 MB view details)

Uploaded Jul 29, 2026 CPython 3.13macOS 11.0+ x86-64

mhm-5.13.4-cp313-cp313-macosx_11_0_arm64.whl (4.7 MB view details)

Uploaded Jul 29, 2026 CPython 3.13macOS 11.0+ ARM64

mhm-5.13.4-cp312-cp312-win_arm64.whl (4.1 MB view details)

Uploaded Jul 29, 2026 CPython 3.12Windows ARM64

mhm-5.13.4-cp312-cp312-win_amd64.whl (6.9 MB view details)

Uploaded Jul 29, 2026 CPython 3.12Windows x86-64

mhm-5.13.4-cp312-cp312-manylinux_2_28_x86_64.whl (5.9 MB view details)

Uploaded Jul 29, 2026 CPython 3.12manylinux: glibc 2.28+ x86-64

mhm-5.13.4-cp312-cp312-manylinux_2_28_aarch64.whl (5.1 MB view details)

Uploaded Jul 29, 2026 CPython 3.12manylinux: glibc 2.28+ ARM64

mhm-5.13.4-cp312-cp312-macosx_11_0_x86_64.whl (6.0 MB view details)

Uploaded Jul 29, 2026 CPython 3.12macOS 11.0+ x86-64

mhm-5.13.4-cp312-cp312-macosx_11_0_arm64.whl (4.7 MB view details)

Uploaded Jul 29, 2026 CPython 3.12macOS 11.0+ ARM64

mhm-5.13.4-cp311-cp311-win_arm64.whl (4.1 MB view details)

Uploaded Jul 29, 2026 CPython 3.11Windows ARM64

mhm-5.13.4-cp311-cp311-win_amd64.whl (6.9 MB view details)

Uploaded Jul 29, 2026 CPython 3.11Windows x86-64

mhm-5.13.4-cp311-cp311-manylinux_2_28_x86_64.whl (5.9 MB view details)

Uploaded Jul 29, 2026 CPython 3.11manylinux: glibc 2.28+ x86-64

mhm-5.13.4-cp311-cp311-manylinux_2_28_aarch64.whl (5.1 MB view details)

Uploaded Jul 29, 2026 CPython 3.11manylinux: glibc 2.28+ ARM64

mhm-5.13.4-cp311-cp311-macosx_11_0_x86_64.whl (6.0 MB view details)

Uploaded Jul 29, 2026 CPython 3.11macOS 11.0+ x86-64

mhm-5.13.4-cp311-cp311-macosx_11_0_arm64.whl (4.7 MB view details)

Uploaded Jul 29, 2026 CPython 3.11macOS 11.0+ ARM64

mhm-5.13.4-cp310-cp310-win_amd64.whl (6.9 MB view details)

Uploaded Jul 29, 2026 CPython 3.10Windows x86-64

mhm-5.13.4-cp310-cp310-manylinux_2_28_x86_64.whl (5.9 MB view details)

Uploaded Jul 29, 2026 CPython 3.10manylinux: glibc 2.28+ x86-64

mhm-5.13.4-cp310-cp310-manylinux_2_28_aarch64.whl (5.1 MB view details)

Uploaded Jul 29, 2026 CPython 3.10manylinux: glibc 2.28+ ARM64

mhm-5.13.4-cp310-cp310-macosx_11_0_x86_64.whl (6.0 MB view details)

Uploaded Jul 29, 2026 CPython 3.10macOS 11.0+ x86-64

mhm-5.13.4-cp310-cp310-macosx_11_0_arm64.whl (4.7 MB view details)

Uploaded Jul 29, 2026 CPython 3.10macOS 11.0+ ARM64

mhm-5.13.4-cp39-cp39-win_amd64.whl (6.9 MB view details)

Uploaded Jul 29, 2026 CPython 3.9Windows x86-64

mhm-5.13.4-cp39-cp39-manylinux_2_28_x86_64.whl (5.9 MB view details)

Uploaded Jul 29, 2026 CPython 3.9manylinux: glibc 2.28+ x86-64

mhm-5.13.4-cp39-cp39-manylinux_2_28_aarch64.whl (5.1 MB view details)

Uploaded Jul 29, 2026 CPython 3.9manylinux: glibc 2.28+ ARM64

mhm-5.13.4-cp39-cp39-macosx_11_0_x86_64.whl (6.0 MB view details)

Uploaded Jul 29, 2026 CPython 3.9macOS 11.0+ x86-64

mhm-5.13.4-cp39-cp39-macosx_11_0_arm64.whl (4.7 MB view details)

Uploaded Jul 29, 2026 CPython 3.9macOS 11.0+ ARM64

File details

Details for the file mhm-5.13.4.tar.gz.

File metadata

Download URL: mhm-5.13.4.tar.gz
Upload date: Jul 29, 2026
Size: 921.4 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for mhm-5.13.4.tar.gz
Algorithm	Hash digest
SHA256	`b984011f24578ccd13ebc41e677b150b548659fd3fbd830849db45db1437a0fb`
MD5	`6168bf4da6835f9f8c5f05bb1cb44c84`
BLAKE2b-256	`c524337c80a77a47d4db38b56ed461394b0d08ad6b91cfc200745404a0d8ed64`

Algorithm	Hash digest
SHA256	`373aa1df7faaf06079f78a450dd3673bd416f8855bac5b9b7f6d2c5e91d65885`
MD5	`35ef45435e3c918fef86958bf42a445c`
BLAKE2b-256	`9399823939cb17ae9f7d68c0afcda56b74526bb5dd634a73f966d76e79b4cd7a`

Algorithm	Hash digest
SHA256	`5f7b5740b09b4d39c443c4fd6b23d680c8fb9bd779fe21275eb874aeb93b4dc3`
MD5	`22d83724add298c439550939a81073f2`
BLAKE2b-256	`3b9d36341ded318e39c9a6bcaf702bb2cb694a9ec2236d332d4a6699161725f0`

Algorithm	Hash digest
SHA256	`bbfbd12052fba79cdb2003aac0b2f8568691c91e55ab3fd849bc6419037ddd76`
MD5	`89fc9ee3bfe67853616352358149e81f`
BLAKE2b-256	`7d72d0d81e0e25a3872fe8b8c8a2e9490869bf1039a3d8d45098d78e11060d02`

Algorithm	Hash digest
SHA256	`d14da55f49a614c96bc991af4accf2ea707f1691eee273a402ffdd0d49fc5838`
MD5	`9fcb28c84b584ff78e7572928d853fcf`
BLAKE2b-256	`dd5f66f2ad9393fc705d633221c290f6b95b601b5765dffd03b5b3420206ca20`

Algorithm	Hash digest
SHA256	`95e8a7f9e87beea6627f6b9b7f404ef46ad723b2a487cae43a1b3942588839ab`
MD5	`162bd91100b136fae95c48926192bd63`
BLAKE2b-256	`9060966e1f141fc9542139282b522d785aa933e15d488e06f5a80d6079199fd1`

Algorithm	Hash digest
SHA256	`0ba23a56a4a9bdba214b2d2a83e571beb0c3a24931cd5b96e28895fdf6972073`
MD5	`04bdcdafbc7c9947b6dbf85f6371741c`
BLAKE2b-256	`8f2d0c46399a6b24cafb2284f5c58a006c8d7de92743671848ab6b42ff7f508a`

Algorithm	Hash digest
SHA256	`27f61d8dfdd536c7d2678ca5fcfe9db66f1b5c4aa3722437d8196dcc3bdf8ee9`
MD5	`34ea0d54b54d722505400971d5e7c552`
BLAKE2b-256	`94ba4e52411a78e0f901890d6b5b183e1f886326a8b9acfb05ca5f554561455d`

Algorithm	Hash digest
SHA256	`c634ef13b89ad0ff779b77ad1eb7283daa7cc83b9433c9deccabceebaf18423a`
MD5	`154732fceca2e589f366c35681666fbd`
BLAKE2b-256	`f08b261f16a1fe4bc56c157065cba5c0c6000f0ff825e923f0d961b7f767b85d`

Algorithm	Hash digest
SHA256	`13a20b95b05b9ed4d1044d6187268e9c21d991359ccc047a829ab5ce76056105`
MD5	`777106513695edd23e6653d7b5b74bdf`
BLAKE2b-256	`1039407bd933d1ad051f85a06e5c7ff32dfec585f1b2149dc2cc3ac39023d889`

Algorithm	Hash digest
SHA256	`8ba88998e193eabf1e5c667bff92d314878e08894d0342b6bdbebd44222813c4`
MD5	`a7f3a10eb922bdf27ad6aa84271b6eb2`
BLAKE2b-256	`584a667bf52eac7d7407e1a8d25bfd0ec4ee618fbea9bf02824ab367e88f28ff`

Algorithm	Hash digest
SHA256	`5427d6a0ceedd4d4e0370f8676be262004e5593583039bc96807ac4f00416996`
MD5	`ba20794051777e8a875ce9307986423d`
BLAKE2b-256	`545c192e797e02f525fccc6f443d37f0778f8b293654816b6ef05f4fd82e4821`

Algorithm	Hash digest
SHA256	`568825da76b1c6ec6ce0cdef0a94be83c54585480599256bdf6d2d12ff1182bb`
MD5	`820791d249ee32e7a1ef9cb01d36412f`
BLAKE2b-256	`85be189f9a1dd0364e4aea978d4e9df3ca9feed720e0eae699da614f78809d95`

Algorithm	Hash digest
SHA256	`a83dff1becb3eb2381a111ad9a53383fab41c16769020b061a48be3e4c857bb3`
MD5	`1c6aa221deb43be349ef011c817a491c`
BLAKE2b-256	`7fa5a81f4664790729cd04aa6261351e58596c74220d10f4324f453f2ac875d6`

Algorithm	Hash digest
SHA256	`93789399837a2a88394d9a36906d89f94b494c4e15ce10b1d609eab4fddc6b1d`
MD5	`a6cc114d81507f0b6556abda506d324a`
BLAKE2b-256	`ef0f40de5768b63e575ebc80af39eb6092f16bc1b9bb943ea91b34e384f1bce7`

Algorithm	Hash digest
SHA256	`85074f852c14e3b462f829a10eed464e2ffc19ac1fb8e7a8a0665acb7dc55cea`
MD5	`fed26725e94672c7c3f56ee32d08630d`
BLAKE2b-256	`91c4dbfd580aa83fb8bcda1c5584b41681320114b4b35a4713f0d3e4708db141`

Algorithm	Hash digest
SHA256	`b04fc483d84220fb6c84be14c8182bd1e937f10a980208836617842612fce7f5`
MD5	`1b14690081d38cbacfa1e72917b8c4f4`
BLAKE2b-256	`eceaedb936c0ae2bd13406d3c17cd81750fafbfdd665c2821f88560d136060f6`

Algorithm	Hash digest
SHA256	`6d32d1489dfc8f2671f88fc65df8a3ef2f7edcad4127d8e306b1a49d951b1d40`
MD5	`931aa2ed86f1cae65299686ea5954d3d`
BLAKE2b-256	`faf6696c1f506bd25aab47685027d9042702a3d802a1e3a83c44cdfe9caa3171`

Algorithm	Hash digest
SHA256	`557031a804b5d1a514ee27897dc1d11995c37e06daba9927a44a06c431f7edd1`
MD5	`e3915569725762e9e76340fb2f449c12`
BLAKE2b-256	`28d403980652240e617f12094a865885e7f057b002b33d774e1e995b2aff4b3f`

Algorithm	Hash digest
SHA256	`7bc1be8185d825ea5e001edef538825331b63aab50c2836c12ca909e9c11544b`
MD5	`4800be606f22220332684a041bad2549`
BLAKE2b-256	`2af890ef409d958ff31689ddb62f3dfc9738e89466467f298e8a0b1dfe634860`

Algorithm	Hash digest
SHA256	`455fc09fdc4ee860ac827baccec464a3b5510cd783b579e8d76e66f7e15030f3`
MD5	`408f869b547334e6eff4eddddd71804f`
BLAKE2b-256	`543b5def48565bb855a44756280e3f032ffb034f2a31269b9fa8f3fce187c531`

mhm 5.13.4

mHM - Python bindings

Installation

Environment variables

Test domain download tool

Documentation

Examples

License

Project links

Key dates

2 maintainers

Credits

License

Requires

Provides Extra

Tags

Classifiers

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

Algorithm	Hash digest
SHA256	`61e4d0d2d62a49a1a93f7fc9749f151cb37154c4ae0b2724570a4348df335744`
MD5	`7fcb3a47d609490bc8955cf7f93b4adb`
BLAKE2b-256	`c096d8e131c556cd276faa448fdafec9e70dcdf5f0ce61b7c91d378529220e2c`

Algorithm	Hash digest
SHA256	`74f20ee292d41584225746a11fb2b773f33f0c158faf4c698c3847fb3ade763e`
MD5	`97280d36307e16c1244b689ca3767101`
BLAKE2b-256	`fd83504af5bb64b2b9895837f30d2b8d1025c6790f56f0d33a0924ed6e50b219`

Algorithm	Hash digest
SHA256	`8663fed84c470c0966354e7861f703f905c591ebb7f29e6f7ceeace0067eda72`
MD5	`151e8a778f1576298d31bfeb6f899011`
BLAKE2b-256	`66880ce7d55dd335cdcef805384296bab5dd607dfe5bb1ef3de1524bb3fd54f7`

Algorithm	Hash digest
SHA256	`309684cf3e6e0c7ba8501378471f0eb7869020064b6dee774afd193485ea3265`
MD5	`0eb92101d91c1ab0e41d9f8a160aea0d`
BLAKE2b-256	`d4793120fedfb2a64f4703001fddb2887dcf46ea125e004e6a1696e59ceefe3e`

Algorithm	Hash digest
SHA256	`79257093eff14b7b2c2d93188cde250640caa45a40a18b5fe352bea54e9ffe9b`
MD5	`a558747b1a4bd373afb5d6a741b4f157`
BLAKE2b-256	`80b74a8acade76f1a33e90d1325ec89540e9da206a63da48d5b81c198054e75c`

Algorithm	Hash digest
SHA256	`03c60247ac0169681d089acb7e2ae44572665c6dd8041e7cd8f3aec96b82281a`
MD5	`5e8c3cd25fa63226ac4547bef9dd6b5f`
BLAKE2b-256	`7abb41f8c92fac42f37ddb5dabaf0aaa3ee3f7d4d78e4f455fd82add394a49b0`

Algorithm	Hash digest
SHA256	`1d33ff340f1225e635a6ed574a471e6f3b4fd9eb1c53af65017c6cdb6701761a`
MD5	`3b4497a8db30a6ab97032837b63fc6d2`
BLAKE2b-256	`ee242d5262ba48f1df4dcc7b9eac3e8365beb429a737763941db2d3a61192b19`

Algorithm	Hash digest
SHA256	`39465e82da632e28ce8a079cfb99507f5b501efe5d75bcdd964a6a9c19f165a3`
MD5	`fd4f43f70d2dec667dfa59a164249faf`
BLAKE2b-256	`b0c612d36d6c88b2d83cd72d6c968925a86872567e943ab5387215a79f0c3a68`

Algorithm	Hash digest
SHA256	`32f5597a735234cab27a72f3b0d535f5ff7e4fbb64551bfc262b326774dfab91`
MD5	`ec19cb567f6919f9bd2abe6ed898d6d4`
BLAKE2b-256	`ce8124927e6438e9096fbf7c96459acb21527da70bc215238699cd031ea57aa7`

Algorithm	Hash digest
SHA256	`dbd7d2d51c6c0f63e68bf7c52259c08eaa2dc04d385254d90e722b89e61e7e42`
MD5	`2c92f59491eba1cfc3f88e9dc588c72a`
BLAKE2b-256	`a5be5097c2b54155935bdf408f71237124a91c440ec35a441065bef9f00a11f5`