Data archive for paper "Machine Learning Emulation of Urban Land Surface Processes"

This archive contains models, data* (Overview), as well as the Singularity image to optionally rerun experiments described in "Machine Learning Emulation of Urban Land Surface Processes".

Prerequisites

Linux or macOS with Bash shell.

Singularity (tested with version 3.6.3-1.el8)

Please note that all steps require Singularity to be installed on your system. If you are looking for information on how to install or use Singularity, please refer to the Singularity documentation.

Overview

A general overview of the repository structure is given below. Due to licensing restrictions analysis and forcing data (*) cannot be included and need to be requested separately (see Initialization). Data derivatives (**) from either analysis or forcing, as well as intermediary data (***), are not included as they can be generated by rerunning experiments (see Usage).

.
├── data
│ ├── analysis*
│ ├── forcing*
│ ├── teb
│ ├── utils
│ ├── wps
│ └── wrf
├── hpc
├── models
│ ├── teb
│ ├── unn
│ ├── wps
│ └── wrf-unn
├── notebooks
├── outputs
│ ├── analysis**
│ ├── benchmark***
│ ├── forcing**
│ ├── kerastuner***
│ ├── notebooks
│ ├── tabular
│ ├── teb**
│ ├── unn**
│ ├── wps***
│ └── wrf
├── paper
│ └── figures
├── singularity
└── tools

Initialization

Forcing and analysis data need to be requested separately. The following directories should map to their respective data archives:

./data/analysis -> Grimmond et al. (2013)

./data/forcing -> Grimmond et al. (2021)

Usage

To rerun all experiments and reproduce results, run tools/run_all.sh from your command prompt. After completion, all results are saved in the outputs directory. Note that WRF simulations require high CPU time and may take hours or days to complete.

Alternatively, if Portable Batch System (PBS) is available on your system, the following helpers may be used instead:

qsub hpc/submit_init.pbs
qsub hpc/submit_tuner.pbs
qsub hpc/submit_unn.pbs
qsub hpc/submit_find_median_unn.pbs
qsub hpc/submit_wrf.pbs
qsub hpc/submit_postprocess.pbs
qsub hpc/submit_benchmark.pbs

Note that you may need to modify PBS helper scripts to suit your specific environment.

Development notes

See DEVELOP.md.

License

The source code developed for this work is licensed under MIT (LICENSE_CODE.txt). For licensing information of third-party software see licenses under the models directory. Data files in this archive, including the initial and boundary condition data from the European Centre for Medium-Range Weather Forecasts (data/wps/ungrib), are licensed under CC BY-NC 4.0 (LICENSE_DATA.txt).