Skip to content

Instantly share code, notes, and snippets.

@hoetmaaiers

hoetmaaiers/config.schema.json

Created September 10, 2024 07:09
Show Gist options
  • Save hoetmaaiers/adb1ba8b7b1cc8b25c3d5d7acc8f172a to your computer and use it in GitHub Desktop.
Save hoetmaaiers/adb1ba8b7b1cc8b25c3d5d7acc8f172a to your computer and use it in GitHub Desktop.
Download ZIP
Raw
config.schema.json
{
"$defs": {
"FnameSettings": {
"properties": {
"landuse_CORINE": {
"description": "Path to the CORINE land use file",
"title": "Landuse Corine",
"type": "string"
},
"landuse_LCZ": {
"description": "Path to the LCZ land use file",
"title": "Landuse Lcz",
"type": "string"
},
"land_params": {
"description": "Path to the land use parameters file. \n\n| Type | Path |\n|:--------------|:----------------------------------------------------------------------|\n| CORINE | `/home/souverin/autourbclim/terrain/land_parameters_CORINE.dat` |\n| WORLDCOVER | `/home/souverin/autourbclim/terrain/land_parameters_WORLDCOVER.dat` |\n| LCZ | `/home/souverin/autourbclim/terrain/land_parameters_LCZ.dat` |",
"title": "Land Params",
"type": "string"
},
"parms": {
"description": "Path to the ECMWF model levels parameter list file",
"title": "Parms",
"type": "string"
},
"soiltexture": {
"description": "Path to the soil texture file. \n\nSpecification of the soil texture parameters - based on Clapp and Hornberger (1978)\n\n| Soil type | etas(m3/m3) | psis(m) | Ksat(m/s) | bch(-) |\n|:----------------|:--------------|:---------|:-----------|:-------|\n| Sand | 0.395 | 0.121 | 1.76E-4 | 4.05 |\n| Loamy sand | 0.441 | 0.090 | 1.56E-4 | 4.38 |\n| Sandy loam | 0.435 | 0.218 | 3.41E-5 | 4.90 |\n| Silty loam | 0.485 | 0.786 | 7.2E-6 | 5.30 |\n| Loam | 0.451 | 0.478 | 7.0E-6 | 5.39 |\n| Sandy clay loam | 0.420 | 0.299 | 6.3E-6 | 7.12 |\n| Silty clay loam | 0.477 | 0.356 | 1.7E-6 | 7.75 |\n| Clay loam | 0.476 | 0.630 | 2.5E-6 | 8.52 |\n| Sandy clay | 0.426 | 0.153 | 2.2E-6 | 10.4 |\n| Silty clay | 0.492 | 0.490 | 1.0E-6 | 10.4 |\n| Clay | 0.482 | 0.405 | 1.3E-6 | 11.4 |\n| ECMWF(default) | 0.472 | 0.338 | 0.57E-6 | 6.04 |\n\nDefault are the avarage values for medium-texture soils from ECMWF,\nsee http://www.ecmwf.int/research/ifsdocs/CY37r2/IFSPart4.pdf p125",
"title": "Soiltexture",
"type": "string"
},
"buildings": {
"description": "Path to the building fraction file",
"title": "Buildings",
"type": "string"
},
"building_height": {
"description": "Path to the building height file",
"title": "Building Height",
"type": "string"
},
"dem": {
"description": "Path to the Digitial Elevation Model (DEM) file",
"title": "Dem",
"type": "string"
},
"soil": {
"description": "Path to the Soil Sealing file\n\n| Type | Path |\n|:--------------|:---------------------------------------------------------------------------------------------|\n| Zhang: | `/projects/urbclim/PREPRO/INPUT/SOILSEALING/Zhang2020/ImperviousMap_global.tif` |\n| GISA: | `/projects/urbclim/PREPRO/INPUT/SOILSEALING/Huang2021/GISA-10m_v01_2016.vrt` |\n| COPERNICUS: | `/projects/urbclim/PREPRO/INPUT/SOILSEALING/COPERNICUS/DATA/IMD_2018_010m_eu_03035_V2_0.tif` |",
"title": "Soil",
"type": "string"
},
"ahf": {
"description": "Path to the Anthropogenic Heat Flux file",
"title": "Ahf",
"type": "string"
}
},
"required": [
"landuse_CORINE",
"landuse_LCZ",
"land_params",
"parms",
"soiltexture",
"buildings",
"building_height",
"dem",
"soil",
"ahf"
],
"title": "FnameSettings",
"type": "object"
}
},
"description": "Main configuration model for an Urban Climate simulation.",
"properties": {
"log_level": {
"default": "INFO",
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
],
"title": "Log Level",
"type": "string"
},
"run_directory": {
"title": "Run Directory",
"type": "string"
},
"base_data_folder": {
"title": "Base Data Folder",
"type": "string"
},
"hourly_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"description": "Hourly output requested",
"title": "Hourly Output"
},
"email_client": {
"description": "Email address of the client",
"format": "email",
"title": "Email Client",
"type": "string"
},
"output_vars": {
"description": "2D static variables\n- X: X-coordinates of URBCLIM grid (nx,ny)\n- Y: Y-coordinates of URBCLIM grid (nx,ny)\n- LAT: Latitude (nx,ny)\n- LON: Longitude (nx,ny)\n- DEM: Terrain height (m) (nx,ny)\n\n2D dynamic variables\n- T2M: 2m air temperature (K) (nx,ny,nt)\n- T10M: Air temperature at first model level (K) (nx,ny,nt)\n- U10M: Zonal wind speed at first model level (m s-1) (nx,ny,nt)\n- V10M: Mer. wind speed at first model level (m s-1) (nx,ny,nt)\n- WS2M: 2m wind speed (m s-1) (nx,ny,nt)\n- WDIR: Wind direction at first model level (\ufffd from N) (nx,ny,nt)\n- QV2M: 2m specific humidity (kg kg-1) (nx,ny,nt)\n- SH: Sensible heat flux (W m-2) (nx,ny,nt)\n- LH: Latent heat flux (W m-2) (nx,ny,nt)\n- BLH: Boundary layer height (m) (nx,ny,nt)\n- USTR: Friction velocity (m s-1) (nx,ny,nt)\n- LST: Land surface temperature (K) (nx,ny,nt)\n- TVG: Vegetation temperature (K) (nx,ny,nt)\n- RAM: Aerodynamic resistance for momentum (s m-1) (nx,ny,nt)\n- RAH: Aerodynamic resistance for heat (s m-1) (nx,ny,nt)\n\n3D atmosphere variables\n- PT: Potential temperature (K) (nx,ny,nz,nt)\n- QV: Specific humidity (kg kg-1) (nx,ny,nz,nt)\n- U: Zonal wind speed (m s-1) (nx,ny,nz,nt)\n- V: Meridional wind speed (m s-1) (nx,ny,nz,nt)\n- W: Vertical wind speed (m s-1) (nx,ny,nz,nt)\n\n3D soil variables\n- TSL: Soil temperature (K) (nx,ny,6,nt)\n- TURB: Urban temperature (K) (nx,ny,6,nt)",
"items": {
"enum": [
"X",
"Y",
"LAT",
"LON",
"DEM",
"T2M",
"T10M",
"U10M",
"V10M",
"WS2M",
"WDIR",
"QV2M",
"SH",
"LH",
"BLH",
"USTR",
"LST",
"TVG",
"RAM",
"RAH",
"PT",
"QV",
"U",
"V",
"W",
"TSL",
"TURB"
],
"type": "string"
},
"title": "Output Vars",
"type": "array"
},
"fname": {
"$ref": "#/$defs/FnameSettings"
},
"authors": {
"items": {
"type": "string"
},
"title": "Authors",
"type": "array"
},
"city": {
"description": "City name of interest",
"title": "City",
"type": "string"
},
"use_advection": {
"title": "Use Advection",
"type": "boolean"
},
"nx": {
"description": "Number of grid cells in the x-direction, WATCH OUT: has to be and odd number to make the data correspond to the center of the grid cells!",
"title": "Nx",
"type": "integer"
},
"ny": {
"description": "Number of grid cells in the y-direction, WATCH OUT: has to be and odd number to make the data correspond to the center of the grid cells!",
"title": "Ny",
"type": "integer"
},
"nz": {
"description": "Number of vertical levels",
"title": "Nz",
"type": "integer"
},
"dxy": {
"default": 250,
"description": "Specification of the horizontal resolution to be used.",
"title": "Dxy",
"type": "integer"
},
"clon": {
"title": "Clon",
"type": "number"
},
"clat": {
"title": "Clat",
"type": "number"
},
"extent_km": {
"title": "Extent Km",
"type": "integer"
},
"tmet": {
"default": 1200,
"description": "Specification of the time resolution for the meteo input (in seconds). \n\n**WATCH OUT!: When setting this parameter too large, the model can become instable.** \n\nDefault value: 1200",
"title": "Tmet",
"type": "integer"
},
"tdmp": {
"default": 3600,
"description": "Output time resolution - time in between output dumps (in seconds).",
"title": "Tdmp",
"type": "integer"
},
"timecor": {
"description": "Specification of the time correction factor (in seconds) to correct UTC time to local time for calculation anthropogenic heat fluxes.",
"title": "Timecor",
"type": "integer"
},
"sst_option": {
"description": "- `MODIS` 4 km monthly SST (only 2010 for now) in surface file (spatially explicit)\n- `ECMWF` 3-hourly SST from model output in ecmwf file (single value)",
"enum": [
"ECMWF",
"MODIS"
],
"title": "Sst Option",
"type": "string"
},
"start_year": {
"description": "Start year of the simulation",
"title": "Start Year",
"type": "integer"
},
"end_year": {
"description": "End year of the simulation",
"title": "End Year",
"type": "integer"
},
"future_periods": {
"description": "List of future periods to simulate",
"items": {
"type": "integer"
},
"title": "Future Periods",
"type": "array"
},
"future_scenarios": {
"description": "List of future scenarios to simulate",
"items": {
"enum": [
"ssp119",
"ssp126",
"ssp245",
"ssp370",
"ssp534-over",
"spp585"
],
"type": "string"
},
"title": "Future Scenarios",
"type": "array"
},
"uncertainty_bool": {
"title": "Uncertainty Bool",
"type": "boolean"
},
"land_option": {
"enum": [
"CORINE",
"WORLDCOVER",
"LCZ"
],
"title": "Land Option",
"type": "string"
},
"veg_option": {
"description": "Vegetation:\n- `NORM`: use regular ndvi image (default, standard runs)\n- `MEAN`: use the mean ndvi per land use type (scenario runs)",
"enum": [
"NORM",
"MEAN"
],
"title": "Veg Option",
"type": "string"
},
"soil_option": {
"description": "Name of the Soil Sealihg Map to be used",
"enum": [
"Zhang",
"GISA",
"COPERNICUS"
],
"title": "Soil Option",
"type": "string"
},
"epsg": {
"title": "Epsg",
"type": "integer"
},
"epsg_output": {
"description": "EPSG code of the output projection (defined by the client)",
"title": "Epsg Output",
"type": "integer"
}
},
"required": [
"run_directory",
"base_data_folder",
"email_client",
"output_vars",
"fname",
"authors",
"city",
"use_advection",
"nx",
"ny",
"nz",
"clon",
"clat",
"extent_km",
"timecor",
"sst_option",
"start_year",
"end_year",
"future_periods",
"future_scenarios",
"uncertainty_bool",
"land_option",
"veg_option",
"soil_option",
"epsg",
"epsg_output"
],
"title": "ConfigModel",
"type": "object"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment