From 368f608529310894e50fe2cdc1366849e5009d30 Mon Sep 17 00:00:00 2001
From: Runar Ask Johannessen <89020325+equinor-ruaj@users.noreply.github.com>
Date: Thu, 23 Nov 2023 10:57:48 +0100
Subject: [PATCH] add Komodo testing section to readme (#18)

* add Komodo testing section to readme
* add note about the Explorer when testing on top of Komodo
---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index d81020a4..b1bac06c 100644
--- a/README.md
+++ b/README.md
@@ -23,3 +23,22 @@ FORWARD_MODEL ECLIPSE100(...)
 --Note: SIM2SUMO must come after ECLIPSE100
 FORWARD_MODEL SIM2SUMO(<S2S_CONFIG_PATH>=path/to/config/file)
 ```
+
+
+## Testing on top of Komodo
+Sim2sumo and [sumo uploader](https://github.com/equinor/fmu-sumo-uploader) are both installed under `fmu/sumo/`.
+This means that the uploader must also be installed to test a new version of sim2sumo on top of Komodo.
+
+Example: Installing sim2sumo from `mybranch` on top of Komodo bleeding
+```
+< Create a new komodo env from komodo bleeding >
+< Activate the new env >
+
+pip install git+https://github.com/equinor/fmu-sumo-sim2sumo.git@mybranch
+pip install git+https://github.com/equinor/fmu-sumo-uploader.git
+```
+
+The [Explorer](https://github.com/equinor/fmu-sumo) is also installed under `fmu/sumo`. Meaning that if the testing scenario includes the Explorer then it should also be installed on top of Komodo.
+```
+pip install git+https://github.com/equinor/fmu-sumo.git
+```