From 9ebfdca3f686c36732fcce28143cb1a25b19e9d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Alonso=20=C3=81lvarez?= Date: Tue, 21 Nov 2023 09:36:21 +0000 Subject: [PATCH 1/6] Initial version of model file --- model_file.yaml | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 model_file.yaml diff --git a/model_file.yaml b/model_file.yaml new file mode 100644 index 0000000..5ab7487 --- /dev/null +++ b/model_file.yaml @@ -0,0 +1,37 @@ +# This is the model file required to deploy WSIMOD in DAFNI +# For details of the file and its specification see: +# +# https://docs.secure.dafni.rl.ac.uk/docs/how-to/how-to-write-a-model-definition-file +# +kind: M +api_version: v1beta2 + +metadata: + display_name: WSIMOD + name: wsimod + summary: WSIMOD is a software for simulating water quality and quantity. + type: model + publisher: Imperial College London + description: > + The terrestrial water cycle is a highly interconnected system where the movement of + water is affected by physical and human processes. Thus, environmental models may + become inaccurate if they do not provide a complete picture of the water cycle, + missing out on unexpected opportunities and omitting impacts that arise from complex + interactions. + + WSIMOD is a modelling framework to integrate these different processes. It provides + a message passing interface to enable different subsystem models to communicate + water flux and water quality information between each other, and self-contained + representations of the key parts of the water cycle (rivers, reservoirs, urban and + rural hydrological catchments, treatment plants, and pipe networks). + +spec: + inputs: + + dataslots: + - name: Settings file + description: Settings file setting up a WSIMOD simulation. + path: inputs/settings.yaml + required: true + +# Other datasets are likely to be needed, but their number is simulation dependent \ No newline at end of file From bf7a4e14aca19092a4ee4af36f9fc4d91bb54b75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Alonso=20=C3=81lvarez?= Date: Fri, 1 Dec 2023 06:58:07 +0000 Subject: [PATCH 2/6] Add DAFNI model file --- model_file.yaml | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/model_file.yaml b/model_file.yaml index 5ab7487..96e56c9 100644 --- a/model_file.yaml +++ b/model_file.yaml @@ -28,10 +28,24 @@ metadata: spec: inputs: + parameters: + - name: WSIMOD_SETTINGS + title: Settings file name + description: The name of the settings file to be used. + type: string + default: settings.yaml + required: true + dataslots: - name: Settings file description: Settings file setting up a WSIMOD simulation. - path: inputs/settings.yaml + path: inputs/ required: true -# Other datasets are likely to be needed, but their number is simulation dependent \ No newline at end of file + - name: Additional Data Files + description: > + These are files, required by the WSIMOD simulation and that contain the input + data. The filenames should be the same as those indicated in the WSIMOD + settings file. + path: inputs/ + required: False From f65f6101afe8be4ffd9ad02530c8be7abf3ae261 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Alonso=20=C3=81lvarez?= Date: Fri, 1 Dec 2023 08:52:11 +0000 Subject: [PATCH 3/6] Update DAFNI model file --- model_file.yaml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/model_file.yaml b/model_file.yaml index 96e56c9..da453eb 100644 --- a/model_file.yaml +++ b/model_file.yaml @@ -4,7 +4,7 @@ # https://docs.secure.dafni.rl.ac.uk/docs/how-to/how-to-write-a-model-definition-file # kind: M -api_version: v1beta2 +api_version: v1beta3 metadata: display_name: WSIMOD @@ -24,6 +24,10 @@ metadata: water flux and water quality information between each other, and self-contained representations of the key parts of the water cycle (rivers, reservoirs, urban and rural hydrological catchments, treatment plants, and pipe networks). + contact_point_email: d.alonso-alvarez@imperial.ac.uk + contact_point_name: Diego Alonso Álvarez + source_code: https://github.com/ImperialCollegeLondon/wsi + licence: https://raw.githubusercontent.com/ImperialCollegeLondon/wsi/main/LICENSE spec: inputs: @@ -40,12 +44,14 @@ spec: - name: Settings file description: Settings file setting up a WSIMOD simulation. path: inputs/ + default: + - 8cea5a04-ac8c-42c7-b742-3864436efef2 required: true - name: Additional Data Files description: > These are files, required by the WSIMOD simulation and that contain the input data. The filenames should be the same as those indicated in the WSIMOD - settings file. + settings file. It can be empty if no data files are required. path: inputs/ required: False From ff55fed84988b384a17119d60e5ab96e6464cdf3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Alonso=20=C3=81lvarez?= Date: Fri, 1 Dec 2023 08:54:42 +0000 Subject: [PATCH 4/6] Update DAFNI model file, again. --- model_file.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/model_file.yaml b/model_file.yaml index da453eb..353f765 100644 --- a/model_file.yaml +++ b/model_file.yaml @@ -42,11 +42,11 @@ spec: dataslots: - name: Settings file - description: Settings file setting up a WSIMOD simulation. + description: > + Settings file setting up a WSIMOD simulation. Providing a settings file is + required. path: inputs/ - default: - - 8cea5a04-ac8c-42c7-b742-3864436efef2 - required: true + required: false - name: Additional Data Files description: > From 115e2f899e7363ca1e331cf29aab0db31bad3420 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Alonso=20=C3=81lvarez?= Date: Fri, 1 Dec 2023 08:58:45 +0000 Subject: [PATCH 5/6] Adds defaults for data and settings files --- model_file.yaml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/model_file.yaml b/model_file.yaml index 353f765..3859800 100644 --- a/model_file.yaml +++ b/model_file.yaml @@ -42,11 +42,11 @@ spec: dataslots: - name: Settings file - description: > - Settings file setting up a WSIMOD simulation. Providing a settings file is - required. + description: Settings file setting up a WSIMOD simulation. path: inputs/ - required: false + default: + - 8cea5a04-ac8c-42c7-b742-3864436efef2 + required: true - name: Additional Data Files description: > @@ -54,4 +54,6 @@ spec: data. The filenames should be the same as those indicated in the WSIMOD settings file. It can be empty if no data files are required. path: inputs/ + default: + - 599816bb-4487-406e-b765-996b64462ba6 required: False From 195011d28aab7073944b7ce9cdac9046597f6245 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Alonso=20=C3=81lvarez?= Date: Fri, 1 Dec 2023 11:08:22 +0000 Subject: [PATCH 6/6] Make last update to the model file --- model_file.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/model_file.yaml b/model_file.yaml index 3859800..5853bc5 100644 --- a/model_file.yaml +++ b/model_file.yaml @@ -45,7 +45,7 @@ spec: description: Settings file setting up a WSIMOD simulation. path: inputs/ default: - - 8cea5a04-ac8c-42c7-b742-3864436efef2 + - 5f2ce2a8-98db-4da2-b6d5-5de869295db5 required: true - name: Additional Data Files