the SUEWS model that speaks python
Project description
# SuPy
[![Build Status](https://dev.azure.com/sunt05/SUEWS/_apis/build/status/sunt05.SuPy?branchName=master)](https://dev.azure.com/sunt05/SUEWS/_build/latest?definitionId=11?branchName=master)
[![Documentation Status](https://readthedocs.org/projects/supy/badge/?version=latest)](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:
![sample plot](./sample_plot.png)
## Tutorial
Please check out [more SuPy tutorials here!](https://supy.readthedocs.io/en/latest/tutorial/tutorial.html)
[![Build Status](https://dev.azure.com/sunt05/SUEWS/_apis/build/status/sunt05.SuPy?branchName=master)](https://dev.azure.com/sunt05/SUEWS/_build/latest?definitionId=11?branchName=master)
[![Documentation Status](https://readthedocs.org/projects/supy/badge/?version=latest)](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:
![sample plot](./sample_plot.png)
## Tutorial
Please check out [more SuPy tutorials here!](https://supy.readthedocs.io/en/latest/tutorial/tutorial.html)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
supy-2018.12.29-py3-none-any.whl
(183.6 kB
view hashes)
Close
Hashes for supy-2018.12.29-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c05d0bbc9254fc1e82cefc989aabf9b65443bdcda0b75e4aae7df0fcbb67672 |
|
MD5 | 1ecf5051cb19179287f52cf44f48d8af |
|
BLAKE2b-256 | 881be24715e0f9eae2fc0b457741880d17a994e027251dc6b30705533f2a63f6 |