Skip to content
This repository has been archived by the owner on Jan 27, 2022. It is now read-only.

sunt05/SuPy

Repository files navigation

SuPy

THIS PROJECT IS ARCHIVED AND NOW MAINTAINED HERE BY @UMEP-dev.

Python Version Support Status Latest Version Status Downloads Launch Binder

Build Status Documentation Status DOI

SUEWS that speaks Python

Installation

SuPy requires 64-bit python 3.6+ and can be installed with pip in command line prompt:

python3 -m pip install supy --upgrade

Quick Demo

Once installed, supy can be quickly started to get SUEWS simulations done:

import supy as sp
import matplotlib.pyplot as plt

#load sample data
df_state_init, df_forcing = sp.load_SampleData()
grid = df_state_init.index[0]

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

#plot results and save figure
res_plot = df_output.SUEWS.loc[grid, ['QN', 'QF', 'QS', 'QE', 'QH']]
ax=res_plot.loc['2012 6 4':'2012 6 6'].resample('30T').mean().plot()
plt.show()
ax.figure.savefig('sample_plot.png')

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

sample plot

Tutorial

Please check out more SuPy tutorials here!