Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update OMPP model addition docs #1949

Merged
merged 4 commits into from
Jan 29, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/en/8-MicroSim/Additions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Adding a New Model

**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](../6-Gitlab/Gitlab.md):

![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-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)

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)
Loading