Add instructions to run WSIMOD in DAFNI

docs/dafni.md

@@ -0,0 +1,34 @@
+# Run WSIMOD in DAFNI
+
+WSIMOD is available to run in DAFNI, the Data & Analytics Facility for National
+Infrastructure to advance UK infrastructure research. This let you run WSIMOD
+simulations, and combining them with other tools, without the need of installing any
+of them.
+
+Assuming you have a DAFNI account, the steps to run a WSIMOD simulation will be the
+following:
+
+- In the `Data` tab:
+  - Upload the input `YAML` file as a dataset.
+  - Upload any other required input files as another dataset. This can contain
+    multiple files.
+- In the `Workflow` tab select the `WSIMOD workflow`.
+- In the `Parameter sets` section, click `Create`.
+- In the page that opens, select the model in the workflow (typically `model-1`), and
+complete the sections at the bottom with the appropriate information:
+  - In the `Parameters`, choose the name of the settings file (normally
+    `settings.yaml` or `config.yaml`)
+  - In the `Datasets`, click in the pen icon and select the datasets you just uploaded
+    for the input `YAML` and the other data files. These all will be put together in the
+    same directory when runnind the simulation.
+- Unselect `model-1`, click `Continue` and complete the required metadata in the next
+screen, like the name of the parameter set.
+- Finally, click in `Execute workflow with parameter set`.
+
+If all goes well, you should then see in the `Workflow` page, `Instances` section, that
+there is a new `Instance` of WSIMOD running. After some time (dending on the
+complexity of the model and the load of the system), the run will finish and there
+will be a new `WISMOD output` dataset available in the `Data` tab.
+
+You can create new workflows to customise this process, name of the outputs, and even
+chain multiple models, one after the other.

docs/index.md

@@ -48,29 +48,33 @@ and consists of:
 
     4.3. [Customise interactions](./demo/scripts/customise_interactions.py)
 
-5. [Component library](component-library.md)
+5. [Command line interface](wsimod-cli.md)
 
-6. [API reference](reference.md)
+6. [Component library](component-library.md)
 
-    6.1. [API reference - arc](reference-arc.md)
+7. [Run WSIMOD in DAFNI](dafni.md)
 
-    6.2. [API reference - core](reference-core.md)
+8. [API reference](reference.md)
 
-    6.3. [API reference - land](reference-land.md)
+    8.1. [API reference - arc](reference-arc.md)
 
-    6.4. [API reference - nodes](reference-nodes.md)
+    8.2. [API reference - core](reference-core.md)
 
-    6.5. [API reference - sewer](reference-sewer.md)
+    8.3. [API reference - land](reference-land.md)
 
-    6.6. [API reference - storage (reservoir, river, groundwater)](reference-storage.md)
+    8.4. [API reference - nodes](reference-nodes.md)
 
-    6.7. [API reference - wtw](reference-wtw.md)
+    8.5. [API reference - sewer](reference-sewer.md)
 
-    6.8. [API reference - other components](reference-other.md)
+    8.6. [API reference - storage (reservoir, river, groundwater)](reference-storage.md)
 
-    6.9. [API reference - model](reference-model.md)
+    8.7. [API reference - wtw](reference-wtw.md)
 
-7. [Coverage](coverage.md)
+    8.8. [API reference - other components](reference-other.md)
+
+    8.9. [API reference - model](reference-model.md)
+
+9. [Coverage](coverage.md)
 
 ## Acknowledgements