Tip
Need help? Please let us know in the UMEP Community.
Find an issue within this page? Please report it in the GitHub issues.
A good understanding of SUEWS is a prerequisite to the proper use of SuPy.
API reference¶
Top-level Functions¶
|
Initialise supy by loading initial model states. |
|
Load forcing data for a specific grid included in the index of df_state_init. |
|
Perform supy simulation. |
|
Save SuPy run results to files |
Load sample data for quickly starting a demo run. |
|
print |
Utility Functions¶
ERA-5 Data Downloader¶
|
Generate ERA-5 cdsapi-based requests and download data for area of interests. |
|
Generate SUEWS forcing files using ERA-5 data. |
Typical Meteorological Year¶
|
Generate an |
|
Read in |
Gap Filling¶
|
Fill all gaps in a time series using data from neighbouring divisions of 'freq' |
OHM¶
|
A function to linearly fit two independant variables to a dependent one. Input params: QS_Ser: QN_Ser: The first independent variable (Net all wave radiation). Pandas Series. Returns: a1, a2 coefficients and a3 (intercept). |
|
Calculate QS using OHM (Objective Hysteresis Model). |
Surface Conductance¶
|
Model surface conductance/resistance using phenology and atmospheric forcing conditions. |
|
Calculate surface conductance based on observations, notably turbulent fluxes. |
|
Calibrate parameters for modelling surface conductance over vegetated surfaces using |
WRF-SUEWS¶
|
Extract reclassification info from |
|
Produce Sankey Diagram to visualise the reclassification specified in |
Plotting¶
|
Produce a scatter plot with linear regression line to compare simulation results and observations. |
|
Produce a ensemble diurnal climatologies with uncertainties shown in inter-quartile ranges. |
|
Produce a quick plot of RSL results |
Roughness Calculation¶
|
Calculates surface roughness and zero plane displacement height. |
|
Calculates the rows associated with neutral condition (threshold=0.01) |