pySWATPlus

pySWATPlus is a Python package that makes working with SWAT+ models easier and more powerful. Whether you're running default setups or custom projects, this tool lets you interact with SWAT+ programmatically, so you can focus on optimizing and analyzing your models like a pro! 🚀

⚠️ Version Compatibility Notice

Version 1.x introduces breaking changes and is not compatible with the previous 0.x versions.

If you're looking for the legacy 0.x version:
📦 Install from PyPI:
```
pip install pySWATPlus==0.2.20
```
🗂️ Access the source code:
https://github.com/swat-model/pySWATPlus/tree/v0.x

✨ Key Features

Access and Modify SWAT+ Files: Navigate, read, modify, and write files in the TxtInOut folder used by SWAT+. 📂
Model Calibration: Optimize SWAT+ input parameters using the Pymoo optimization framework to get the best results. 🎯

⚠️ Note: The SWATProblem and SWATProblemMultimodel classes have been removed in version 1.x. Tutorials on how to perform calibration analysis will be updated soon.

📦 About

pySWATPlus is an open-source software developed and maintained by ICRA. It’s available for download and installation via PyPI.

⚙️ Requirements

To use this package, a Python version above 3.10 is required.

📥 Install pySWATPlus

Once the dependencies are installed, you can install pySWATPlus using this simple command:

pip install pySWATPlus

🚀 Getting Started

The Getting Started notebook is the perfect place to begin your journey with pySWATPlus. It covers the basics and links to practical examples, from setting up and running a simple SWAT+ project to diving into parameter optimization techniques and sensitivity analysis.

For a deeper dive, check out the API Reference, which documents all functions, input arguments, and provides short examples on how to use them. The API Reference includes:

TxtinoutReader: Work with SWAT+ input and output files.
FileReader: Read and manipulate SWAT+ files.

📖 Citation

To cite pySWATPlus, use:

@software{joan_salo_2025_16380058,
  author       = {Joan Saló and
                  Debasish Pal and
                  Oliu Llorente},
  title        = {swat-model/pySWATPlus: Release v1.0.1},
  month        = jul,
  year         = 2025,
  publisher    = {Zenodo},
  version      = {v1.0.1},
  doi          = {10.5281/zenodo.16380058},
  url          = {https://doi.org/10.5281/zenodo.16380058},
  swhid        = {swh:1:dir:22ad2f4e620c3ef99bc62dd880cbc05c0be3c2b8
                   ;origin=https://doi.org/10.5281/zenodo.14889319;vi
                   sit=swh:1:snp:4dc18853eb47c828caa36afd324ab58c8c8c
                   02b2;anchor=swh:1:rel:c2e6bc6de431c7201ab6f484fc30
                   96b43cb5a90e;path=swat-model-pySWATPlus-022f59a
                  },
}