Skip to main content

README

This is the README file for a collection of Python scripts that implement the Comparison Model Method (CMM, [1], [2], [3] and [4]).

For more details about the tests and the methodology, please see the manuscript “Improving the robustness of the Comparison Model Method for the identification of hydraulic transmissivities” by A.Comunian and M.Giudici (submitted to Computers & Geosciences).


Purpose

This is a python implementation of the Comparison Model Method (CMM), a direct method to solve inverse problems in hydrogeology, and in particular to compute the hydraulic conductivity T of a confined aquifer given an initial tentative value of T and one or more interpolated hydraulic head fields h. This implementation of the CMM heavily relies on the USGS engines of the Modflow family (and Modflow6 in particular) to solve the forward problem, facilitated by the use of the Python module flopy. Nevertheless, it can be adapted to make use of other engines for the solution of the forward problem.


Installation


Requirements

In addition to the common Python modules numpy, scipy and matplotlib, this codes requires a recent version of flopy.


Download and install

The suggested way is to use pip (which should be also already available with Anaconda).

cmmpy is available at the Python Package Index repository. Therefore, in can be easily installed (together with its dependencies) with the command:

pip install cmmpy

Alternatively, if you prefer to download the sources from https://bitbucket.org/alecomunian/cmmpy, you can:

  1. Clone or download this repository on your hard drive.

  2. If required, unpack it and cd cmmpy.

  3. Inside the project directory, from the command line:

    pip install -e .
  4. To check if it worked, open a Python terminal and try:

    import cmmpy

Run the tests

  1. Move into the folder ŧest.

  2. Then, from the shell, use the script run_cmm.py to run the corresponding test by providing the name of the JSON parameter file as unique input argument, like for example:

    ./run_cmm.py template/test.json
  3. This should create (in the folder defined by the wdir variable in the JSON parameter file) all the output of the selected test.

If you want to run multiple test, have a look at the script run_all.py.


Contacts

This code was developed by the HydroGeophysics Lab. of the University of Milan. Please do not hesitate to contact us should you require more information or interested in contributing.


References

Metadata

Release files for cmmpy 0.1.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 cmmpy 0.1.3
File Size Uploaded Provenance Actions
cmmpy-0.1.3.tar.gz 29.6 kB Without provenance Details for cmmpy-0.1.3.tar.gz

Release files / cmmpy-0.1.3.tar.gz

Download URL cmmpy-0.1.3.tar.gz
Size 29.6 kB
Tags Source
SHA-256 checksum
How to use checksums
db4817fb5450821cf27a94664955b59dba8e700d2f55798f76e122329058d57c
BLAKE2b-256 checksum
How to use checksums
73bfd0957a17455348ff5907b7c7beafbf48ce219ca2fe567eff472da84f6df2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.9

Security for cmmpy 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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