Skip to content

Commit

Permalink
feat(docs): translate microsim (#1928)
Browse files Browse the repository at this point in the history
* feat(docs): translate microsim

* fix(translation): AAW --> l'EAA
  • Loading branch information
bryanpaget authored Jan 9, 2024
1 parent 38c29c5 commit 1c77c09
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 9 deletions.
14 changes: 5 additions & 9 deletions docs/en/8-MicroSim/GettingStarted.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@

# 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.
# Getting started with Kubeflow and OpenM++.

This document is intended to act as an introduction to The AAW's Kubeflow Notebook servers and their use for the OpenM++ project.

## Starting

Expand All @@ -18,7 +17,7 @@ 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)
![Kubeflow Management Panel](../images/KFMP01.png)

## Create a notebook.

Expand Down Expand Up @@ -61,11 +60,11 @@ If the **Connect button** is disabled, click on the triangle (Start image) butto

## Your Kubeflow notebook.

![Kube Flow screen](../images/KFNotebook01.png)
![Kubeflow screen](../images/KFNotebook01.png)

To start the OpenM++ UI, click on the OpenM++ icon on the Notebooks page.

![Kube Flow screen](../images/KFNotebook09.png)
![Kubeflow screen](../images/KFNotebook09.png)

This will open a new window with the OpenM++ UI running.

Expand All @@ -78,8 +77,6 @@ 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)
Expand Down Expand Up @@ -122,4 +119,3 @@ 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)

120 changes: 120 additions & 0 deletions docs/fr/8-MicroSim/demarrage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
# Premiers pas avec Kubeflow et OpenM++.

Ce document est destiné à servir d'introduction aux Bloc-note de Kubeflow sur la plateforme EAA et à leur utilisation pour le projet OpenM++.

## Démarrage

Pour accéder au portail Kubeflow de l'EAA, accédez au site Web suivant.

[https://kubeflow.aaw-dev.cloud.statcan.ca/](https://kubeflow.aaw-dev.cloud.statcan.ca/)

Cela vous redirigera vers une page de connexion Microsoft.

![Connexion01](../images/Connexion01.png)

Sélectionnez le compte que vous souhaitez utiliser et procédez à l'authentification.

Une fois vos informations d'identification authentifiées, vous serez redirigé vers le panneau de gestion Kubeflow de l'EAA.

![Panneau de gestion Kubeflow](../images/KFMP01.png)

## Créez un bloc-note.

Cliquez sur le bouton Créer un nouveau serveur bloc-note.

![Créer bloc-note01](../images/CreateNB01.png)

Cela fait apparaître le nouvel écran du bloc-notes.

Pour créer un nouveau carnet, trois éléments doivent être définis :
- Assurez-vous que le bon espace de noms est sélectionné.
- Un nom unique.
- Cliquez ensuite sur le type de carnet souhaité.
- Pour OpenM++, sélectionnez l'option JupyterLab.
- Si vous travaillez avec des données protégées B, cochez la case **Exécuter dans le bloc-notes protégé B**.

Faites défiler vers le bas pour voir le **Bouton de lancement.** Le bouton de lancement ne sera actif qu'une fois les options ci-dessus sélectionnées.

![Écran du portable](../images/NewNBScreen02.png)

Appuyez sur le bouton Lancer pour lancer votre nouveau bloc-notes.

[Pour plus d'informations sur Kubeflow de l'EAA, cliquez ici.](https://statcan.github.io/aaw/en/1-Experiments/Kubeflow/)

### Carnets existants

Si vous avez déjà créé un carnet, vous pouvez le réutiliser en cliquant sur l'onglet Carnets.

![Écran du portable](../images/NewNBScreen03.png)

Cela fera apparaître une fenêtre avec tous vos blocs-notes existants.

![Écran du portable](../images/NewNBScreen04.png)

Pour démarrer un ordinateur portable existant, sélectionnez-le et appuyez sur le bouton CONNECT.

Si le **bouton Connecter** est désactivé, cliquez sur le bouton triangle (Démarrer l'image) pour démarrer l'image, puis cliquez sur **connecter** lorsqu'il devient disponible.

![Écran du portable](../images/startNb01.png)

## Votre carnet Kubeflow.

![Écran Kubeflow](../images/KFNotebook01.png)

Pour démarrer l'interface utilisateur OpenM++, cliquez sur l'icône OpenM++ sur la page bloc-notes.

![Écran Kubeflow](../images/KFNotebook09.png)

Cela ouvrira une nouvelle fenêtre avec l'interface utilisateur OpenM++ en cours d'exécution.

## Interface utilisateur OpenM++

![Écran de l'interface utilisateur OpenM](../images/OpenMUI01.png)


Cliquez sur le symbole Ellipses dans le coin supérieur gauche pour changer de langue.

![Écran de l'interface utilisateur OpenM](../images/OpenMUI02.png)

Cliquez sur le menu Hamburger en haut à droite pour ouvrir la barre latérale.

![Écran de l'interface utilisateur OpenM](../images/OpenMUI03.png)

Stockez les modèles et les données dans le bucket de stockage Blob monté sur le bloc-note.

non classé : `/home/jovyan/buckets/aaw-unclassified/microsim/models`
protégé-b : `/home/jovyan/buckets/protected-b/microsim/models`

Les fichiers journaux doivent apparaître sous le répertoire parent « Microsim ».

Veuillez consulter le lien suivant pour plus d'informations sur ce sujet :

[Stockage Azure Blob](https://statcan.github.io/aaw/en/5-Storage/AzureBlobStorage/)

Cliquez sur le modèle souhaité (panneau de gauche) pour le sélectionner.

Cela fait apparaître le panneau d'exécution du modèle et active les onglets Scénarios d'entrée et Exécuter le modèle sur le panneau de droite.

![Écran de l'interface utilisateur OpenM](../images/OpenMUI04.png)

Les onglets horizontaux sont également actifs (mais grisés) à ce moment-là.

![Écran de l'interface utilisateur OpenM](../images/OpenMUI05.png)

Pour exécuter un modèle, vous devez d'abord saisir le nom du modèle. Cliquer dans la zone Nom du modèle générera un nom de modèle horodaté de manière unique pour l'exécution.

![Écran de l'interface utilisateur OpenM](../images/OpenMUI06.png)

Pour exécuter des modèles utilisant le multi-traitement (MPI), les opérations suivantes doivent être effectuées. Cela ne fonctionnera que pour les modèles compatibles MPI.

Dans l'onglet **Options d'exécution du cluster**, assurez-vous que :
- au moins un Processus est sélectionné dans le **MPI Nombre de Processus** et
- le modèle sélectionné dans le **MPI Model Run Template** est : **mpi.ModelRun.template.txt**

![Options du cluster OpenM UI](../images/OpenMUI08.png)

Vous pouvez ensuite cliquer sur **Exécuter le modèle** pour exécuter la tâche.

Cela exécutera le modèle et affichera le panneau de résultats de l'exécution du modèle qui affiche les résultats de l'exécution.

![Écran de l'interface utilisateur OpenM](../images/OpenMUI07.png)

0 comments on commit 1c77c09

Please sign in to comment.