Skip to content

Commit

Permalink
Update OMPP model addition docs (#1949)
Browse files Browse the repository at this point in the history
* fix(microsim): add file extension

* docs(ompp): update model location

* docs(microsim): direct link to Gitlab
  • Loading branch information
Souheil-Yazji authored Jan 29, 2024
1 parent b7aa33a commit 07be6f1
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions docs/en/8-MicroSim/Additions.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Adding a New Model

**Note**: use a notebook with at least 4Gb of memory for this full guide.
**Note**: use a notebook with at least 6Gb 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:
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](../6-Gitlab/Gitlab.md):

![Oncosim dir is now available](image.png)

Expand All @@ -14,14 +14,10 @@ We can follow the readme of the model. In this case, we set our `OM_ROOT` enviro

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`.
Once compilation is complete, our compiled model files appear under `<path-to-model>/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)

0 comments on commit 07be6f1

Please sign in to comment.