Welcome to pyswap documentation¶
pyswap is the first comprehensive Python wrapper for the SWAP hydrological model (version 4.2). It allows you to create and interact with these models using Python, including interactive tools like Jupyter notebooks. pyswap integrates HDF5 as stofage for models and a universal exchange file format, facilitating seamless collaboration with R users, who can utilize packages like SWAP Tools to handle SWAP models. Additionally, it integrates with external databases, such as KNMI for Dutch weather data and the WOFOST crop parameter database.
The model variables are based on the original input files from SWAP developers, the user manual (Kroes et al., 2017), and other documents available on the SWAP website.
Note
While pyswap already supports core SWAP functionalities, there's plenty of room for improvement. Contributions are highly encouraged, whether it's opening issues or starting discussions on GitHub. For more details on how to contribute, visit the contribute section and get involved!
Quick links¶
-
Quickstart
Learn how to install the package and get you started with your first model.
-
Input validation
pySWAP uses Pydantic and Pandera validation frameworks to make sure SWAP simulations run smoothly
-
Markdown documentation
This documentation is written in markdown allowing anyone to contribute
-
Open Software - Open Science
pySWAP is open-source with MIT license and aims at improving transparency and sharability of modelling work