diff --git a/docs/en/8-MicroSim/GettingStarted.md b/docs/en/8-MicroSim/GettingStarted.md new file mode 100644 index 000000000..db903db60 --- /dev/null +++ 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 new file mode 100644 index 000000000..1f079b499 Binary files /dev/null and b/docs/en/images/CreateNB01.png differ diff --git a/docs/en/images/KFMP01.png b/docs/en/images/KFMP01.png new file mode 100644 index 000000000..4911bcc6f Binary files /dev/null and b/docs/en/images/KFMP01.png differ diff --git a/docs/en/images/KFNotebook01.png b/docs/en/images/KFNotebook01.png new file mode 100644 index 000000000..753b9036f Binary files /dev/null and b/docs/en/images/KFNotebook01.png differ diff --git a/docs/en/images/KFNotebook02.png b/docs/en/images/KFNotebook02.png new file mode 100644 index 000000000..6914e129f Binary files /dev/null and b/docs/en/images/KFNotebook02.png differ diff --git a/docs/en/images/KFNotebook03.png b/docs/en/images/KFNotebook03.png new file mode 100644 index 000000000..ca90bdb8d Binary files /dev/null and b/docs/en/images/KFNotebook03.png differ diff --git a/docs/en/images/KFNotebook04.png b/docs/en/images/KFNotebook04.png new file mode 100644 index 000000000..d61eac25e Binary files /dev/null and b/docs/en/images/KFNotebook04.png differ diff --git a/docs/en/images/KFNotebook05.png b/docs/en/images/KFNotebook05.png new file mode 100644 index 000000000..795c1a0a5 Binary files /dev/null and b/docs/en/images/KFNotebook05.png differ diff --git a/docs/en/images/KFNotebook06.png b/docs/en/images/KFNotebook06.png new file mode 100644 index 000000000..ae0a5b5d8 Binary files /dev/null and b/docs/en/images/KFNotebook06.png differ diff --git a/docs/en/images/KFNotebook07.png b/docs/en/images/KFNotebook07.png new file mode 100644 index 000000000..d4517f623 Binary files /dev/null and b/docs/en/images/KFNotebook07.png differ diff --git a/docs/en/images/KFNotebook08.png b/docs/en/images/KFNotebook08.png new file mode 100644 index 000000000..de7468d95 Binary files /dev/null and b/docs/en/images/KFNotebook08.png differ diff --git a/docs/en/images/KFNotebook09.png b/docs/en/images/KFNotebook09.png new file mode 100644 index 000000000..94368f789 Binary files /dev/null and b/docs/en/images/KFNotebook09.png differ diff --git a/docs/en/images/Login01.png b/docs/en/images/Login01.png new file mode 100644 index 000000000..8d492d674 Binary files /dev/null and b/docs/en/images/Login01.png differ diff --git a/docs/en/images/NewNBScreen01.png b/docs/en/images/NewNBScreen01.png new file mode 100644 index 000000000..f5fd038d8 Binary files /dev/null and b/docs/en/images/NewNBScreen01.png differ diff --git a/docs/en/images/NewNBScreen02.png b/docs/en/images/NewNBScreen02.png new file mode 100644 index 000000000..9269686c2 Binary files /dev/null and b/docs/en/images/NewNBScreen02.png differ diff --git a/docs/en/images/NewNBScreen03.png b/docs/en/images/NewNBScreen03.png new file mode 100644 index 000000000..a21e99874 Binary files /dev/null and b/docs/en/images/NewNBScreen03.png differ diff --git a/docs/en/images/NewNBScreen04.png b/docs/en/images/NewNBScreen04.png new file mode 100644 index 000000000..6f64c3b87 Binary files /dev/null and b/docs/en/images/NewNBScreen04.png differ diff --git a/docs/en/images/OpenMUI01.png b/docs/en/images/OpenMUI01.png new file mode 100644 index 000000000..ce39ade98 Binary files /dev/null and b/docs/en/images/OpenMUI01.png differ diff --git a/docs/en/images/OpenMUI02.png b/docs/en/images/OpenMUI02.png new file mode 100644 index 000000000..7a29b867a Binary files /dev/null and b/docs/en/images/OpenMUI02.png differ diff --git a/docs/en/images/OpenMUI03.png b/docs/en/images/OpenMUI03.png new file mode 100644 index 000000000..65c7a22eb Binary files /dev/null and b/docs/en/images/OpenMUI03.png differ diff --git a/docs/en/images/OpenMUI04.png b/docs/en/images/OpenMUI04.png new file mode 100644 index 000000000..cae2c6ef1 Binary files /dev/null and b/docs/en/images/OpenMUI04.png differ diff --git a/docs/en/images/OpenMUI05.png b/docs/en/images/OpenMUI05.png new file mode 100644 index 000000000..c3b664bbe Binary files /dev/null and b/docs/en/images/OpenMUI05.png differ diff --git a/docs/en/images/OpenMUI06.png b/docs/en/images/OpenMUI06.png new file mode 100644 index 000000000..fc81bc5f0 Binary files /dev/null and b/docs/en/images/OpenMUI06.png differ diff --git a/docs/en/images/OpenMUI07.png b/docs/en/images/OpenMUI07.png new file mode 100644 index 000000000..75095e983 Binary files /dev/null and b/docs/en/images/OpenMUI07.png differ diff --git a/docs/en/images/OpenMUI08.png b/docs/en/images/OpenMUI08.png new file mode 100644 index 000000000..2d3e61fa5 Binary files /dev/null and b/docs/en/images/OpenMUI08.png differ diff --git a/docs/en/images/startNb01.png b/docs/en/images/startNb01.png new file mode 100644 index 000000000..8fad31387 Binary files /dev/null and b/docs/en/images/startNb01.png differ