Ompp build docs (#1926)

* feat(ompp-docs): add ompp to mkdocs * docs(ompp): add docs for compiling
StatCan · Dec 19, 2023 · bf7ca99 · bf7ca99
1 parent 99a8ebf
commit bf7ca99
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 0 deletions.
diff --git a/docs/en/8-MicroSim/Additions b/docs/en/8-MicroSim/Additions
@@ -0,0 +1,27 @@
+## Adding a New Model
+
+**Note**: use a notebook with at least 4Gb of memory for this full guide. 
+
+First clone the model's repository or download and extract the archived model on your AAW notebook. In our example, we clone oncosim from gitlab:
+
+![Oncosim dir is now available](image.png)
+
+### Compiling the model
+
+In this case, we are compiling for mpi, so we retrieved the appropriate OMPP release from the [openmpp releases page](https://github.com/openmpp/main/releases). Make sure to use the archived releases provided by openM and not auto-generated by Github. 
+
+We can follow the readme of the model. In this case, we set our `OM_ROOT` environment variable to the same directory as our OMPP release using `export OM_ROOT=~/buckets/aaw-unclassified/microsim/openmpp_ubuntu_mpi_20231115`.
+
+We can now compile. We make sure that we're in the oncosim directory then run `make OM_MSG_USE=MPI RELEASE=1 all publish`. 
+
+Once compilation is complete, our compiled model files appear under `<path-to-oncosim>/ompp-linux/bin/`. Using the terminal, `cp` the files in the `bin` directory to `~/buckets/aaw-unclassified/microsim/models/bin`.
+
+![oncosim model files under bin](image-2.png)
+
+Using the terminal, `cp -r ` the entire model directory to `~/buckets/aaw-unclassified/microsim/models`
+
+![oncosim under microsim](image-1.png)
+
+Once complete, run `restart-oms.sh` in the terminal. This will restart the OpenM web service and allow it to pick up the new model.
+
+![model in UI](image-3.png)
diff --git a/docs/en/8-MicroSim/image-1.png b/docs/en/8-MicroSim/image-1.png
diff --git a/docs/en/8-MicroSim/image-2.png b/docs/en/8-MicroSim/image-2.png
diff --git a/docs/en/8-MicroSim/image-3.png b/docs/en/8-MicroSim/image-3.png
diff --git a/docs/en/8-MicroSim/image.png b/docs/en/8-MicroSim/image.png
diff --git a/mkdocs-en.yml b/mkdocs-en.yml
@@ -113,4 +113,5 @@ nav:
       - Integrate with External PaaS: 7-MLOps/PaaS-Integration.md
   - MicroSim:
       - Getting Started: 8-MicroSim/GettingStarted.md
+      - Adding new models: 8-MicroSim/Additions.md
   - Help/Contact: Help.md