title | journal | author | affiliation | Date | abstract | running | competinginterests | algorithms | copyrightstatement | availability | videosupplement | authorcontribution | disclaimer | acknowledgements | appendix | output | export_on_save | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
A Python-enhanced urban land surface model SuPy (SUEWS in Python, v2019.2): development, deployment and demonstration |
gmd |
|
|
10 Feb 2019 |
Accurate and agile modelling of the climate of cities is essential for urban climate services. The Surface Urban Energy and Water balance Scheme (SUEWS) is a state-of-the-art, widely used, urban land surface model (ULSM) which simulates urban-atmospheric interactions by quantifying the energy, water and mass fluxes. Using SUEWS as the computation kernel, SuPy (SUEWS in Python), stands on the Python-based data stack to streamline the pre-processing, computation and post-processing that are involved in the common modelling-centred urban climate studies. This paper documents the development of SuPy, which includes the SUEWS interface modification, F2PY (Fortran to Python) configuration and Python frontend implementation. In addition, the deployment of SuPy via PyPI (Python Package Index) is introduced along with the automated workflow for cross-platform compilation. This makes SuPy available for all mainstream operating systems (Windows, Linux, and macOS). Furthermore, three online tutorials in Jupyter notebooks are provided to users of different levels to become familiar with SuPy urban climate modelling. The SuPy package represents a significant enhancement that supports existing and new model applications, reproducibility, and enhanced functionality.
|
|
The authors declare no competing interests.
|
true |
The author's copyright for this publication is transferred to institution/company.
|
|
use this section when having video supplements available
|
Daniel wrote the package. Josiah thought about poterry. Markus filled in for a second author.
|
We like Copernicus.
|
Thanks to the rticles contributors!
|
\section{Figures and tables in appendices}
\subsection{Option 1}
If you sorted all figures and tables into the sections of the text, please also sort the appendix figures and appendix tables into the respective appendix sections.
They will be correctly named automatically.
\subsection{Option 2}
If you put all figures after the reference list, please insert appendix tables and figures after the normal tables and figures.
`\appendixfigures` needs to be added in front of appendix figures
`\appendixtables` needs to be added in front of appendix tables
Please add `\clearpage` between each table and/or figure. Further guidelines on figures and tables can be found below.
Regarding figures and tables in appendices, the following two options are possible depending on your general handling of figures and tables in the manuscript environment:
To rename them correctly to A1, A2, etc., please add the following commands in front of them:
|
|
|
To address these considerations, SuPy's architecture uses Python's data processing and Fortran's computational efficiency. SuPy consist of three parts (@fig:schematic):
-
SUEWS: a Fortran-coded local scale urban land surface model of moderate complexity that can simulate the urban surface energy balance in combination with the complete urban hydrological cycle, considering irrigation and runoff processes (Grimmond and Oke, 1986, Grimmond and Oke 1991, Grimmond et al. 1991, Offerle et al. 2003, Järvi et al. 2011, Jarvi et al. 2014, Ward et al. 2016).
-
SuPy_driver: calculation kernel compiled by F2PY (Fortran to Python, part of the NumPy package) (Peterson, 2009) to facilitate the transfer of SUEWS Fortran modelling ability to Python and guarantee the computational performance.
-
SuPy: a Python-based frontend processor using pandas
DataFrame
and derived functionality for data analysis and simulation management.