pySWAP

Python Interface to SWAP (Soil, Water, Atmosphere and Plant) to simulates transport of water, solutes and heat in unsaturated/saturated soils.
https://github.com/zawadzkim/pyswap

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Last synced: about 1 hour ago
JSON representation

Repository metadata

Python wraper for SWAP hydrological model

README.md

pySWAP - Python wraper for SWAP hydrological model

CD
CI
Docs
codecov
pypi
downloads
Binder
DOI

pySWAP is a Python wrapper (not Python implementation) for the SWAP hydrological model (link to the model website). It simplifies the creation of input files, execution of the SWAP model, and analysis and visualization of results. Users can set up and document their models in Jupyter notebooks, enhancing transparency, collaboration, and facilitating community-supported debugging.

Contributing

pySWAP is in the early stages of development so any contributions are highly encouraged. You can open issues, submit pull requests, or initiate discussions on GitHub. For more details on how you can contribute, visit the CONTRIBUTE section and get involved!

Help

Consult pySWAP documentation page for detailed instructions.

Installation

The easiest way to install the package is through pip:

pip install pyswap

You can also clone the repository from github:

git clone --recurse-submodules https://github.com/zawadzkim/pySWAP.git

Notice, that there is the recurse-submodules flag that makes sure additional libraries are also cloned.

Docker

For consistent execution across different systems, you can use Docker:

docker build -t pyswap .
docker run -it --rm -v "$PWD":/workspace pyswap
python your-script.py

For detailed Docker instructions, see the Docker documentation.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: "pyswap: Python wrapper for SWAP hydrological model."
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Mateusz
    family-names: Zawadzki
    email: zawadzkimat@outlook.com
    affiliation: Vrije Universiteit Brussel
    orcid: "https://orcid.org/0000-0001-9524-4208"
identifiers:
  - type: doi
    value: 10.5281/zenodo.14884488
    description: latest pyswap release
repository-code: "https://github.com/zawadzkim/pySWAP"
url: "https://zawadzkim.github.io/pySWAP/"
abstract: >-
  pySWAP is a Python wrapper (not Python implementation) for
  the SWAP hydrological model. It simplifies the creation of
  input files, execution of the SWAP model, and analysis and
  visualization of results. Users can set up and document
  their models in Jupyter notebooks, enhancing transparency,
  collaboration, and facilitating community-supported
  debugging.
keywords:
  - vadose zone
  - hydrology
  - SWAP model
  - 1D model
license: MIT
date-released: "2025-02-17"

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 454
Total Committers: 5
Avg Commits per committer: 90.8
Development Distribution Score (DDS): 0.163

Commits in past year: 126
Committers in past year: 5
Avg Commits per committer in past year: 25.2
Development Distribution Score (DDS) in past year: 0.302

Name Email Commits
Mateusz z****t@o****m 380
zawadzkim M****i@v****e 38
zawadzkim z****2@g****m 32
markvdbrink m****k@w****l 2
Thomas Berends t****s@h****m 2

Committer domains:


Issue and Pull Request metadata

Last synced: 10 days ago

Total issues: 28
Total pull requests: 52
Average time to close issues: about 2 months
Average time to close pull requests: 1 day
Total issue authors: 2
Total pull request authors: 3
Average comments per issue: 0.14
Average comments per pull request: 0.1
Merged pull request: 42
Bot issues: 0
Bot pull requests: 0

Past year issues: 23
Past year pull requests: 21
Past year average time to close issues: 2 months
Past year average time to close pull requests: 4 days
Past year issue authors: 2
Past year pull request authors: 3
Past year average comments per issue: 0.09
Past year average comments per pull request: 0.24
Past year merged pull request: 15
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/zawadzkim/pyswap

Top Issue Authors

  • markvdbrink (22)
  • zawadzkim (6)

Top Pull Request Authors

  • zawadzkim (41)
  • markvdbrink (9)
  • tberends (2)

Top Issue Labels

  • bug (7)
  • enhancement (4)
  • documentation (1)

Top Pull Request Labels

  • bug (2)
  • documentation (1)
  • enhancement (1)

Package metadata

pypi.org: pyswap

Python wrapper for SWAP hydrological model.

  • Homepage:
  • Documentation: https://zawadzkim.github.io/pyswap/
  • Licenses: MIT
  • Latest release: 0.3.9 (published 10 days ago)
  • Last Synced: 2026-02-03T17:47:32.694Z (6 days ago)
  • Versions: 22
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 757 Last month
  • Rankings:
    • Dependent packages count: 10.773%
    • Average: 35.724%
    • Dependent repos count: 60.675%
  • Maintainers (1)

Score: 11.674108502561618