Merge pull request #1895 from StatCan/openMpp#20_Docs

Open mpp#20 docs
StatCan · Nov 23, 2023 · 1f1607e · 1f1607e
2 parents a9e9acb + 43bcc29
commit 1f1607e
Show file tree

Hide file tree

Showing 26 changed files with 125 additions and 0 deletions.
diff --git a/docs/en/8-MicroSim/GettingStarted.md b/docs/en/8-MicroSim/GettingStarted.md
@@ -0,0 +1,125 @@
+
+# Getting started with Kubeflow Notebooks and OpenM++.
+
+This document is intended to act as an introduction to The AAWs Kubeflow Notebook servers and their use for the OpenM++ project.
+
+
+## Starting
+
+To access the AAW Kubeflow portal, navigate to the following website.
+
+[https://kubeflow.aaw.cloud.statcan.ca/](https://kubeflow.aaw.cloud.statcan.ca/) 
+
+This will redirect you to a Microsoft log-in page.
+
+![Login01](../images/Login01.png)
+
+Select the account you wish to use and proceed with the authentication.
+
+After your credentials are authenticated, you will be redirected to the AAW Kubeflow management panel. 
+
+![Kube Flow Management Panel](../images/KFMP01.png)
+
+## Create a notebook.
+
+Click on the Create a New Notebook server button.
+
+![Create Notebook01](../images/CreateNB01.png)
+
+This brings up the new Notebook screen.
+
+To create a new Notebook, three things must be set:
+- Ensure the correct Namespace is selected.
+- A unique name.
+- Then click on the Notebook type you want.
+  - For OpenM++, select the JupyterLab option.
+- If you are working with Protected B Data, select the **Run in Protected B notebook** checkbox
+
+Scroll down to see the **Launch Button.**  The Launch button will only be active after the above options are selected.
+
+![Notebook screen](../images/NewNBScreen02.png)
+
+Press the Launch button to launch you new Notebook.
+
+[For more information about Statcan AAW Kubeflow, Click here.](https://statcan.github.io/aaw/en/1-Experiments/Kubeflow/)
+
+### Existing Notebooks
+
+If you have previously created a notebook, you can reuse it by clicking on the Notebooks Tab.
+
+![Notebook screen](../images/NewNBScreen03.png)
+
+This will bring up a window with all your existing Notebooks.  
+
+![Notebook screen](../images/NewNBScreen04.png)
+
+To start an existing Notebook, select it and press the CONNECT button.
+
+If the **Connect button** is disabled, click on the triangle (Start image) button to start the image, and then click on **connect** when it becomes avaliable .
+
+![Notebook screen](../images/startNb01.png)
+
+## Your Kubeflow notebook.
+
+![Kube Flow screen](../images/KFNotebook01.png)
+
+To start the OpenM++ UI, click on the OpenM++ icon on the Notebooks page.
+
+![Kube Flow screen](../images/KFNotebook09.png)
+
+This will open a new window with the OpenM++ UI running.
+
+## OpenM++ UI
+
+![OpenM UI screen](../images/OpenMUI01.png)
+
+
+Click on the Ellipses symbol on the upper Left corner to change language.
+
+![OpenM UI screen](../images/OpenMUI02.png)
+
+
+
+Click on the Hamburger Menu on the top right to open the sidebar.
+
+![OpenM UI screen](../images/OpenMUI03.png)
+
+Store Models and Data in the Notebook's mounted Blob storage bucket.
+
+unclassified: `/home/jovyan/buckets/aaw-unclassified/microsim/models`
+protected-b: `/home/jovyan/buckets/protected-b/microsim/models`
+
+The log files should appear under the `Microsim` parent directory.
+
+Please see the following link for more information on this topic:
+
+[Azure Blob storage](https://statcan.github.io/aaw/en/5-Storage/AzureBlobStorage/)
+
+Click on the Model you want (Left Panel) to select it.  
+
+This brings up the Model Run Panel and activates the Input Scenarios and Run the Model tabs on the Right Panel.
+
+![OpenM UI screen](../images/OpenMUI04.png)
+
+The horizontal tabs are also active (but greyed out) at this time.
+
+![OpenM UI screen](../images/OpenMUI05.png)
+
+To Run a Model, first the Model name must be entered.  Clicking in the Model Name box will generate a uniquely timestamped Model name for the run.
+
+![OpenM UI screen](../images/OpenMUI06.png)
+
+To run models using multi-processing (MPI), the following must be done.  This will only work for MPI enabled models.
+
+In the **Cluster Run Options** tab, ensure that:
+- at least one Process is selected in the **MPI Number of Processes** and
+- the templated selected in the **MPI Model Run Template** is: **mpi.ModelRun.template.txt**
+
+![OpenM UI Cluster options](../images/OpenMUI08.png)
+
+You can then click the **Run the Model** to run the job.
+
+This will run the Model and brings up the Model Run Results Panel which shows the results of the run.
+
+![OpenM UI screen](../images/OpenMUI07.png)
+
diff --git a/docs/en/images/CreateNB01.png b/docs/en/images/CreateNB01.png
diff --git a/docs/en/images/KFMP01.png b/docs/en/images/KFMP01.png
diff --git a/docs/en/images/KFNotebook01.png b/docs/en/images/KFNotebook01.png
diff --git a/docs/en/images/KFNotebook02.png b/docs/en/images/KFNotebook02.png
diff --git a/docs/en/images/KFNotebook03.png b/docs/en/images/KFNotebook03.png
diff --git a/docs/en/images/KFNotebook04.png b/docs/en/images/KFNotebook04.png
diff --git a/docs/en/images/KFNotebook05.png b/docs/en/images/KFNotebook05.png
diff --git a/docs/en/images/KFNotebook06.png b/docs/en/images/KFNotebook06.png
diff --git a/docs/en/images/KFNotebook07.png b/docs/en/images/KFNotebook07.png
diff --git a/docs/en/images/KFNotebook08.png b/docs/en/images/KFNotebook08.png
diff --git a/docs/en/images/KFNotebook09.png b/docs/en/images/KFNotebook09.png
diff --git a/docs/en/images/Login01.png b/docs/en/images/Login01.png
diff --git a/docs/en/images/NewNBScreen01.png b/docs/en/images/NewNBScreen01.png
diff --git a/docs/en/images/NewNBScreen02.png b/docs/en/images/NewNBScreen02.png
diff --git a/docs/en/images/NewNBScreen03.png b/docs/en/images/NewNBScreen03.png
diff --git a/docs/en/images/NewNBScreen04.png b/docs/en/images/NewNBScreen04.png
diff --git a/docs/en/images/OpenMUI01.png b/docs/en/images/OpenMUI01.png
diff --git a/docs/en/images/OpenMUI02.png b/docs/en/images/OpenMUI02.png
diff --git a/docs/en/images/OpenMUI03.png b/docs/en/images/OpenMUI03.png
diff --git a/docs/en/images/OpenMUI04.png b/docs/en/images/OpenMUI04.png
diff --git a/docs/en/images/OpenMUI05.png b/docs/en/images/OpenMUI05.png
diff --git a/docs/en/images/OpenMUI06.png b/docs/en/images/OpenMUI06.png
diff --git a/docs/en/images/OpenMUI07.png b/docs/en/images/OpenMUI07.png
diff --git a/docs/en/images/OpenMUI08.png b/docs/en/images/OpenMUI08.png
diff --git a/docs/en/images/startNb01.png b/docs/en/images/startNb01.png