supy 2018.12.29

the SUEWS model that speaks python

# SuPy

[](https://dev.azure.com/sunt05/SUEWS/_build/latest?definitionId=11?branchName=master)

[](https://supy.readthedocs.io/en/latest/?badge=latest)

[**SU**EWS](https://suews-docs.readthedocs.io) that speaks **Py**thon

## Installation
SuPy requires `python` 3.5+ and can be installed with `pip` in commmand line prompt:

```shell
python3 -m pip install supy --upgrade
```

## Quickstart
Once installed, `supy` can be quickly started to get [SUEWS](https://suews-docs.readthedocs.io) simulations done:

```python
import supy as sp

# load sample data
df_state_init, df_forcing = sp.load_SampleData()

# run supy/SUEWS simulation
df_output, df_state_end = sp.run_supy(df_forcing, df_state_init)

# plot results
res_plot = df_output.SUEWS.loc[1, ['QN', 'QF', 'QS', 'QE', 'QH']]
res_plot.loc['2012 6 4':'2012 6 6'].resample('30T').mean().plot()
```

The above code will produce a plot of surface energy balance components as follows:


## Tutorial
Please check out [more SuPy tutorials here!](https://supy.readthedocs.io/en/latest/tutorial/tutorial.html)