Skip to main content

Python package for (unsaturated) soil properties including pedotransfer functions

Project description

pedon

PyPI PyPi Supported Python Versions Code Size PyPi Downloads License

DOI JOSS

Tests Coverage Typed: Mypy Typed: Ty Formatter and Linter: Ruff

Pedon (from Greek: πέδον, pedon -> soil) is a Python package for working with unsaturated soil hydraulic properties. It provides an object-oriented framework for soils, soil samples, and soil hydraulic models, making it easy to describe, analyze, and parameterize soil water retention and hydraulic conductivity behavior. At its core, Pedon treats each soil model as a Python class that defines a soil water retention curve and an unsaturated hydraulic conductivity function. The package currently includes implementations of several widely used models:

Pedon allows these models to be evaluated directly and fitted to data. When laboratory measurements of soil water retention and/or unsaturated hydraulic conductivity are available, model parameters can be estimated by fitting analytical curves to the data using nonlinear least squares, following the same methodology as the widely used RETC.

To support parameterization without direct measurements, Pedon includes access to several established soil hydraulic parameter datasets:

In addition, Pedon implements multiple pedotransfer functions that estimate soil hydraulic parameters from easily measured soil properties:

By combining soil hydraulic models, reference datasets, pedotransfer functions, and fitting routines in a single, consistent framework, Pedon makes it straightforward to move from soil information—whether coarse texture data or detailed laboratory measurements—to parameterized soil models ready for use in variably saturated flow simulations.

If you use this software in your research or analyses, please cite the package via its Zenodo archive:

Vonk, M. A. & Peche, A. (XXXX). Pedon: A Python package for analyzing unsaturated soil hydraulic properties (vX.X.X). Zenodo. doi.org/10.5281/zenodo.18222514.

Installation

To get the latest stable version install using:

pip install pedon

To get the development version download the GitHub code to your computer. Use cd to get to the download directory and install using:

pip install -e .

Documentation

The documentation for Pedon is available at https://martinvonk.github.io/pedon/. It includes an extensive user guide with Jupyter Notebooks as examples and an API reference.

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

pedon-0.1.0.tar.gz (57.1 kB view details)

Uploaded Source

Built Distribution

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

pedon-0.1.0-py3-none-any.whl (37.6 kB view details)

Uploaded Python 3

File details

Details for the file pedon-0.1.0.tar.gz.

File metadata

  • Download URL: pedon-0.1.0.tar.gz
  • Upload date:
  • Size: 57.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for pedon-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c3a258705b29c0d3244358f3bbb474ef404324a2c87e7b67281fb25c4a61b272
MD5 1eb2904f290e6c4e497760dee3e31b7a
BLAKE2b-256 e31b64645f0186682319b6c617a8076c8c2057a048598e2f7ca116816344b9ca

See more details on using hashes here.

File details

Details for the file pedon-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pedon-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 37.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for pedon-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc2dd737095bc8a0eb641256690fb1765a3b3e7e9b6e867970dd5487741ca414
MD5 05c4d99d281450920d0629cdcba9aae3
BLAKE2b-256 ec5b9c0d2eb2286ba9d14a7e81a4393dbc811aed81aa261d8313b75adbd38c1b

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