Metadata-Version: 2.4
Name: swatoutpy
Version: 0.1.2
Summary: A Python package to read SWAT model output files (.rch, .sub, .hru)
Author-email: Gokhan Cuceloglu <cuceloglugokhan@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/gokhancuceloglu/swatoutpy
Project-URL: Source, https://github.com/gokhancuceloglu/swatoutpy
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: pandas

# swatoutpy

A lightweight Python package to read SWAT model (Rev 681) output files: `.rch`, `.sub`, and `.hru`.

## How to install

```bash
pip install swatoutpy
```

## How to use

For `*.rch` files

```bash
from swatoutpy.reader import read_rch

df = read_rch("output.rch", timestep="monthly")
print(df.head())
```

For `*.sub` files

```bash
from swatoutpy.reader import read_sub

df = read_sub("output.sub", timestep="annual")
print(df.head())
```

For multiple files

```bash
from swatoutpy.reader import read_multiple_rch

scenarios = [
    ("./sce1/output.rch", "Sce-1"),
    ("./sce1/output.rch", "Sce-2")
]

df = read_multiple_rch(scenarios, timestep="monthly")
print(df.head())
```
