Skip to main content

This package aims to provide machine learning (ML) functions for performing comprehensive soil and groundwater data analysis, and for supporting the establishment of effective long-term monitoring.

Project description

PyLEnM

PyPI version Documentation Status

This package aims to provide machine learning (ML) functions for performing comprehensive soil and groundwater data analysis, and for supporting the establishment of effective long-term monitoring. The package includes unsupervised ML for identifying the spatiotemporal patterns of contaminant concentrations (e.g., PCA, clustering), and supervised ML for evaluating the ability of estimating contaminant concentrations based on in situ measurable parameters, as well as the effectiveness of well configuration to capture contaminant concentration distributions. Currently, the main focus is to analyze historical groundwater datasets and to extract key information such as plume behaviors and controlling (or proxy) variables for contaminant concentrations (Schmidt et al., 2018). This is setting a ground for integrating new technologies such as in situ sensors, geophysics and remote sensing data.

This development is a part of the Advanced Long-Term Monitoring Systems (ALTEMIS) project. In this project, we propose to establish a new paradigm of long-term monitoring based on state-of-the-art technologies – in situ groundwater sensors, geophysics, drone/satellite-based remote sensing, reactive transport modeling, and AI – that will improve effectiveness and robustness, while reducing the overall cost.

The latest package can be downloaded from: https://pypi.org/project/pylenm/

More information on the project can be found here: https://altemis.lbl.gov/ai-for-soil-and-groundwater-contamination/


Installation

(Optional) Create a virtual environment

conda create --name pylenm_env python=3.8
conda activate pylenm_env

Install PyLEnM

Option 1 — Install from PyPI

pip install pylenm

Option 2 — Install from source

git clone https://github.com/hkzhao7/pylenm.git
cd pylenm
pip install .

Repository root: https://github.com/hkzhao7/pylenm/tree/main


Journal Publication

PyLEnM: A Machine Learning Framework for Long-Term Groundwater Contamination Monitoring Strategies
Aurelien O. Meray, Savannah Sturla, Masudur R. Siddiquee, Rebecca Serata, Sebastian Uhlemann, Hansell Gonzalez-Raymat, Miles Denham, Himanshu Upadhyay, Leonel E. Lagos, Carol Eddy-Dilek, and Haruko M. Wainwright
Environmental Science & Technology, 2022, 56 (9), 5973–5983
DOI: https://doi.org/10.1021/acs.est.1c07440


Demonstration Notebooks

The following notebooks demonstrate the current and most complete version of PyLEnM using sample-based groundwater datasets.
They are the default learning resources for new users.

Run on GitHub (view/download):
https://github.com/hkzhao7/pylenm/tree/main/notebooks

Run on Google Colab (no local setup):


Contributors

Aurelien Meray
Haruko Wainwright
Himanshu Upadhyay
Masudur Siddiquee
Savannah Sturla
Nivedita Patel
Kay Whiteaker
Haokai Zhao


Maintainers

Haokai Zhao
Haruko Wainwright

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

pylenm-2.7.5.tar.gz (95.1 kB view details)

Uploaded Source

Built Distribution

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

pylenm-2.7.5-py3-none-any.whl (105.1 kB view details)

Uploaded Python 3

File details

Details for the file pylenm-2.7.5.tar.gz.

File metadata

  • Download URL: pylenm-2.7.5.tar.gz
  • Upload date:
  • Size: 95.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.16

File hashes

Hashes for pylenm-2.7.5.tar.gz
Algorithm Hash digest
SHA256 b526bce02af9dc833bfce5e37451ad83ac4fb4c729b49f41a5189728bee0fd09
MD5 2d98e9940c30473f82c95f6198e70c3a
BLAKE2b-256 afd2f55a69fae417279e13a598d00f1f46b886afadddb0f79d47f91467fefb2c

See more details on using hashes here.

File details

Details for the file pylenm-2.7.5-py3-none-any.whl.

File metadata

  • Download URL: pylenm-2.7.5-py3-none-any.whl
  • Upload date:
  • Size: 105.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.16

File hashes

Hashes for pylenm-2.7.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9c993745e0a5f3ba5a893e7e34af9d6b7b2c177e95ac02dc1ec82db24100ed91
MD5 a0db5f4530dc4c1a6f46e6aba40e0b53
BLAKE2b-256 39ea10572c5d9fed71c32f82ae0ef6a6b7ca23e1ac8a5cfdb3eeae1dcbb240b2

See more details on using hashes here.

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