pySWAP is a Python wrapper (not Python implementation) for the SWAP hydrological model developed at Wageningen University and Research (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.

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!

Consult pySWAP documentation page for detailed instructions.

As this is still a development version, the package is only available through GitHub. You can install it by cloning the repository and installing it in your environment using pip:

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

Then go inside the freshly cloned repo and type:

pip install .

If you would like to adapt the software and share it, install it in interactive mode:

pip install -e .