doc: Update env-sample and README

README.md

@@ -29,29 +29,26 @@ The model (as per 2024-04-19) assumes that a weather data file named `YYYY_with_
 In order to run the model, the following environment variables need to be set:
 
 ```bash
+# Default value is False
+DEBUG=False
 # This is used to auto generate some variables and file names
 MODEL_ID="ADASMELIAE"
 # The start date MM-DD of the model
 START_DATE_MM_DD=03-01
 # The end date MM-DD of the model
 END_DATE_MM_DD=04-01
-# Default value is False
-DEBUG=False
-
 # Where your script resides
 HOME_DIR=/foo/home/ADASMELIAE/
+# Path to folder for intermediary results
+TMP_DIR=/foo/home/ADASMELIAE/tmp/
 # Path to the weather data
 WEATHER_DATA_DIR=/foo/weather/
-# Path to directory for intermediary results
-TMP_DIR=/foo/home/ADASMELIAE/tmp/
+# Used to construct filename from current year
+WEATHER_DATA_FILENAME_DATEFORMAT="%Y_with_forecast.nc"
 # Path to the output (GeoTIFF) files as seen from the running model code
 RESULT_TIF_DIR=/foo/out/tif/
 # Path to the generated mapfile as seen from the running model code
 RESULT_MAPFILE_DIR=/foo/out/mapfile/
-# Used to construct filename from current year
-WEATHER_DATA_FILENAME_DATEFORMAT="%Y_with_forecast.nc"
-# Path to optional CSV file with polygons for masking result.
-MASK_FILE=europe_coastline.csv
 # The path to the output (GeoTIFF files) as seen from Mapserver
 MAPSERVER_RESULT_TIF_DIR=/foo/mapserver/data/ADASMELISAE/
 # Where your generated MAPFILE and query templates should be placed
@@ -62,6 +59,8 @@ MAPSERVER_LOG_FILE=/foo/mapserver/log/ADASMELISAE.log
 MAPSERVER_IMAGE_PATH=/foo/mapserver/image/
 # The value of the EXTENT parameter in Mapserver's mapfile. Units are DD (Decimal degrees)
 MAPSERVER_EXTENT="-23.5 29.5 62.5 70.5"
+# Path to optional CSV file with polygons for masking result.
+MASK_FILE=europe_coastline.csv
 ```
 
 ...this is the contents of the `env-sample` file
@@ -80,6 +79,7 @@ The model outputs GeoTIFF files, two per day in the season/period of calculation
 
 - `result_WARNING_STATUS_[YYYY-MM-DD].tif`, which indicates migration risk.
   - 2 = Low migration risk (yellow)
+  - 3 = Medium migration risk (orange)
   - 4 = High migration risk (red)
 - `result_[YYYY-MM-DD].tif`, which contains the daily maximum air temperature
 

env-sample

 # Use this as an example to create your own .env file
 
+# Default value is False
+DEBUG=False
 # This is used to auto generate some variables and file names
 MODEL_ID="ADASMELIAE"
-# Where your application resides
-HOME_DIR=/home/foo/2023_vips_in_space/ADASMELIAE/
+# The start date MM-DD of the model
+START_DATE_MM_DD=03-01
+# The end date MM-DD of the model
+END_DATE_MM_DD=04-01
+# Where your script resides
+HOME_DIR=/foo/home/ADASMELIAE/
+# Path to folder for intermediary results
+TMP_DIR=/foo/home/ADASMELIAE/tmp/
 # Path to the weather data
-WEATHER_DATA_DIR=in/
-# Used for iterating the weather data files
-WEATHER_DATA_FILENAME_PATTERN="met_1_0km_nordic-*.nc"
-# Used to extract date info from the filename
-WEATHER_DATA_FILENAME_DATEFORMAT="met_1_0km_nordic-%Y-%m-%d.nc"
-# Names of weather parameters in NetCDF files
-# Hourly precipitation
-RR="RR"
-# Relative humidity (2m)
-UM="UM"
-# Timezone for weather data/daily aggregations
-LOCAL_TIMEZONE="Europe/Oslo"
-# Path to optional CSV file with polygons for masking result. 
-# MASK_FILE=Norge_landomrader.csv
+WEATHER_DATA_DIR=/foo/weather/
+# Used to construct filename from current year
+WEATHER_DATA_FILENAME_DATEFORMAT="%Y_with_forecast.nc"
 # Path to the output (GeoTIFF) files as seen from the running model code
-DATA_DIR=out/
+RESULT_TIF_DIR=/foo/out/tif/
 # Path to the generated mapfile as seen from the running model code
-MAPFILE_DIR=mapfile/
+RESULT_MAPFILE_DIR=/foo/out/mapfile/
 # The path to the output (GeoTIFF files) as seen from Mapserver
-MAPSERVER_DATA_DIR=/foo/mapserver/data/ADASMELIAE/
+MAPSERVER_RESULT_TIF_DIR=/foo/mapserver/data/ADASMELISAE/
 # Where your generated MAPFILE and query templates should be placed
-MAPSERVER_MAPFILE_DIR=/foo/mapserver/wms/ADASMELIAE/
+MAPSERVER_RESULT_MAPFILE_DIR=/foo/mapserver/wms/ADASMELISAE/
 # Where mapserver logs for this WMS are written
-MAPSERVER_LOG_FILE=/foo/mapserver/log/ADASMELIAE.log
+MAPSERVER_LOG_FILE=/foo/mapserver/log/ADASMELISAE.log
 # Path to the temporary directory for writing temporary files and images. Must be writable by the user the web server is running as
-MAPSERVER_IMAGE_PATH=/foo/mapserver/tmp/
+MAPSERVER_IMAGE_PATH=/foo/mapserver/image/
 # The value of the EXTENT parameter in Mapserver's mapfile. Units are DD (Decimal degrees)
-MAPSERVER_EXTENT="-1.5831861262936526 52.4465003983706595 39.2608060398730458 71.7683216082912736"
-
-# Default value is false
-#DEBUG=True
+MAPSERVER_EXTENT="-23.5 29.5 62.5 70.5"
+# Path to optional CSV file with polygons for masking result.
+MASK_FILE=europe_coastline.csv
\ No newline at end of file
\ No newline at end of file