Skip to main content

This package reads, writes and runs LUMPREM2 and associated utility programs

Project description

Lumpyrem

Python package to interact with the LUMPREM software suite. Lumpyrem is very much a work in progress. User beware.

If you find a bug or think the software is not working as intended, please submit an issue.

Contributors

Rui Hugman https://github.com/rhugman
Kevin Hayley https://github.com/khayley

DOI

Introduction

Lumpyrem is a Python package that facilitates interaction with the LUMPREM lumped-parameter recharge model and its ancillary programs that assist in setup, and provide a linkage between LUMPREM and MODFLOW 6. It is intended to make setting up and running LUMPREM models easier, in particular if integrated into Flopy workflows.

LUMPREM requires daily inputs of rainfall and potential ET. Nonlinear relationships based on stored soil moisture are used to calculate recharge, runoff and actual ET. The parameters which govern these relationships can be adjusted by PEST. Numerous quantities of interest are recorded on LUMPREM’s output file. These include residual daily ET (which can be reformatted for input to the EVT package of MODFLOW), irrigation demand, and boundary condition head. The latter is calculated using a parameterizable, nonlinear relationship between head and stored soil moisture. Heads calculated in this way can be assigned to MODFLOW boundary conditions after appropriate re-formatting.

Installation

Lumpyrem requires LUMPREM, LUMPREP and LR2SERIES. Executables can be downloaded from the PESTHomepage.org. It is recomended these be placed in a folder in the environment path on your local machine. Alternatively, the executables may be placed within the workspace folder.

You can install Lumpyem from PyPi:

pip install lumpyrem

Installing from the git-hub repository is recommended; the PyPi version lags behind updates in the git-repo.

Documentation

Documentation is a work in progress. Jupyter Notebooks are provided with simple examples of code functionality.

LUMPREM and utilities are extensively documented by their developer.

To do

  • deploy documentation to readthedocs
  • utility to read lumprem output and convert to Feflow timeseries/.pow files
  • utility to write PEST template files DONE
  • make OS independent

Funding

Development of Lumpyrem has been supported in part by the Groundwater Modelling Decision Support Initiative (GMDSI). https://gmdsi.org/

Project details


Download files

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

Source Distribution

lumpyrem-0.1.3.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

lumpyrem-0.1.3-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

Details for the file lumpyrem-0.1.3.tar.gz.

File metadata

  • Download URL: lumpyrem-0.1.3.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for lumpyrem-0.1.3.tar.gz
Algorithm Hash digest
SHA256 9ce127ae3427b0a6c659002da425193f70b27499b0040fd515c9c429ee891de4
MD5 bba26e6ad443f67f89d37b65a89b7cee
BLAKE2b-256 2f7a36f84fd590baa8b7790fa3e42077951d56189c4bf2f1db1a3cc22111a728

See more details on using hashes here.

File details

Details for the file lumpyrem-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: lumpyrem-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 13.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for lumpyrem-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 66042fc3a930810acbd1b2040878ac716a58cfd17223c521764eb607967f5f15
MD5 4370f547a7b7d8870dcf148e4df121f3
BLAKE2b-256 3b01a14587cc829b62a81a38ad658ba7d020febb8cca126701ef7bdb6035bd4a

See more details on using hashes here.

Supported by

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