diff --git a/SLEW_Case1_Electromagnetic_Phenomena.ipynb b/SLEW_Case1_Electromagnetic_Phenomena.ipynb
index 9da2446aa01e8ad671e6a8efdd5a482e94a87234..84fda7b16a71852b93692b2bb155ce5883960922 100644
--- a/SLEW_Case1_Electromagnetic_Phenomena.ipynb
+++ b/SLEW_Case1_Electromagnetic_Phenomena.ipynb
@@ -229,7 +229,7 @@
"outputs": [],
"source": [
"# Access result using token\n",
- "# r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
+ "r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
]
},
{
@@ -340,7 +340,7 @@
"outputs": [],
"source": [
"# Access result using token\n",
- "# r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
+ "r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
]
},
{
@@ -452,7 +452,7 @@
"outputs": [],
"source": [
"# Access result using token\n",
- "# r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
+ "r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
]
},
{
diff --git a/SLEW_Case2_Electromechanical_Phenomena.ipynb b/SLEW_Case2_Electromechanical_Phenomena.ipynb
index 2f0c71d70e91f95b89152a85f5ed4ec219670bd4..73d25ab6eea623412ec60a431ccd3ea3fad68254 100644
--- a/SLEW_Case2_Electromechanical_Phenomena.ipynb
+++ b/SLEW_Case2_Electromechanical_Phenomena.ipynb
@@ -173,7 +173,7 @@
"outputs": [],
"source": [
"# Access result using token\n",
- "# r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
+ "r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
]
},
{
@@ -246,7 +246,7 @@
"outputs": [],
"source": [
"D=input('D in Subtask 2.b:')\n",
- "print('Your result is', 'correct!' if round(float(D),3)==round(outputs['D2'],3) else 'incorrect. You should double-check your calculations.')\n"
+ "print('Your result is', 'correct!' if round(float(D),3)==round(outputs['D2'],3) else 'incorrect. You should double-check your calculations.')"
]
},
{
@@ -274,7 +274,7 @@
"outputs": [],
"source": [
"# Access result using token\n",
- "# r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
+ "r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
]
},
{
@@ -373,7 +373,7 @@
"outputs": [],
"source": [
"# Access result using token\n",
- "# r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
+ "r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')"
]
},
{
diff --git a/SLEW_Platform_Tutorial.ipynb b/SLEW_Platform_Tutorial.ipynb
index 3424ee37acc5813e57f730250047f3ea4454b39f..a4260a9abce995a9c297ee7c33ca6e2bb9e845b3 100644
--- a/SLEW_Platform_Tutorial.ipynb
+++ b/SLEW_Platform_Tutorial.ipynb
@@ -16,7 +16,7 @@
"## How to access VILLASweb?\n",
" \n",
"- Navigate to **VILLASweb** by clicking on the following link [https://slew.rwth-aachen.de](https://slew.rwth-aachen.de). \n",
- "- Click on the \"Sign in with JupyterHub\" button \n",
+ "- Click on the *Sign in with JupyterHub* button \n",
"\n",
"<br>\n",
"<center>\n",
@@ -24,7 +24,7 @@
"</center>\n",
"<br>\n",
"\n",
- "- Click on the \"Authorize\" button to enable that **VILLASweb** reuses your **JupyterHub** authentication\n",
+ "- Click on the *Authorize* button to enable that **VILLASweb** reuses your **JupyterHub** authentication\n",
"\n",
"<br>\n",
"<center>\n",
@@ -32,7 +32,7 @@
"</center>\n",
"<br>\n",
"\n",
- "- Then, you should end up on the startpage of **VILLASweb** \n",
+ "- Then you should end up on the startpage of **VILLASweb** \n",
"\n",
"<br>\n",
"<center>\n",
@@ -50,11 +50,9 @@
"***\n",
"## How to choose your scenario?\n",
"\n",
- "Each user has two scenarios: \n",
- " 1. `SLEW - Individual Experiments` \n",
- " 2. `SLEW - Joint Experiments` \n",
+ "Each user has two scenarios: **SLEW - Individual Experiments** and **SLEW - Joint Experiments**.\n",
"\n",
- "- Navigate to \"Scenarios\"\n",
+ "- Navigate to *Scenarios*\n",
"\n",
"<br>\n",
"<center>\n",
@@ -62,7 +60,7 @@
"</center>\n",
"<br>\n",
"\n",
- "- Choose `SLEW - Individual Experiments` to reach the individual, isolated working space created for you:\n",
+ "- Choose here **SLEW - Individual Experiments** to reach the individual, isolated working space created for you\n",
" \n",
"<br>\n",
"<center>\n",
@@ -78,11 +76,9 @@
"***\n",
"## How to reach the case dashboard?\n",
"\n",
- "Each scenario can have multiple dashboards. For example, the scenario `SLEW - Individual Experiments` has two dashboards: \n",
- " 1. `Case 1: Electromagnetic Phenomena of Synchronous Machines` \n",
- " 2. `Case 2: Electromechanical Phenomena of Synchronous Machines` \n",
+ "Each scenario can have multiple dashboards. For example, the scenario **SLEW - Individual Experiments** has two dashboards: **Case 1: Electromagnetic Phenomena of Synchronous Machines** and **Case 2: Electromechanical Phenomena of Synchronous Machines**.\n",
"\n",
- "- Navigate to the dashboard `Case 1: Electromagnetic Phenomena of Synchronous Machines`:\n",
+ "- Navigate to the dashboard **Case 1: Electromagnetic Phenomena of Synchronous Machines**:\n",
"\n",
"<br>\n",
"<center>\n",
@@ -90,8 +86,8 @@
"</center>\n",
"<br>\n",
"\n",
- "In general, a dashboard contains a set of widget to display the grid topology, observe the status of the simulator and control the simulation.\n",
- "Besides, it can contain interactive widgets (e.g. buttons to trigger certain events) or real-time data plot."
+ "In general, a dashboard contains widgets to display the grid topology, observe the status of the simulator and control the simulator.\n",
+ "Besides, it can contain interactive widgets (e.g. to trigger certain events) or real-time data plots."
]
},
{
@@ -101,9 +97,9 @@
},
"source": [
"***\n",
- "## Simulation parametrisation, execution\n",
+ "## How to parametrise and execute a simulation?\n",
"\n",
- "The **Player Widget** enables you to parametrise and control the simulator.\n",
+ "The **Player Widget** enables you to parametrise and control the simulator\n",
"\n",
"<br>\n",
"<center>\n",
@@ -111,7 +107,7 @@
"</center>\n",
"<br>\n",
"\n",
- "To modify the parameters of your simulation, click on the simulator configuration button\n",
+ "- To modify the parameters of your simulation, click on the **simulator configuration** button\n",
"\n",
"<br>\n",
"<center>\n",
@@ -120,43 +116,43 @@
"<br>\n",
"\n",
"\n",
- "To edit a certain parameter click on the button next to it\n",
+ "- To **edit a parameter** click on the button next to its current value\n",
"\n",
"<br>\n",
"<center>\n",
- " <img src=\"figures/ModifyParameter.PNG'\" width=\"150\"> \n",
+ " <img src=\"figures/ModifyParameter.png\" width=\"150\"> \n",
"</center>\n",
"<br>\n",
"\n",
- "Enter the desired numerical value und click on the small, lower tick symbol (not the upper one)\n",
+ "- **Enter a numerical value** und click on the tick symbol\n",
"\n",
"<br>\n",
"<center>\n",
- " <img src=\"figures/EnterNumericalValue.PNG\" width=\"150\"> \n",
+ " <img src=\"figures/EnterNumericalValue.png\" width=\"300\">\n",
"</center>\n",
"<br>\n",
"\n",
- "If your simulator is not in the \"idle\" state, \"reset\" your simulator \n",
+ "- If your simulator is not in the *idle* state, ***reset* your simulator**\n",
"\n",
"<br>\n",
"<center>\n",
- " <img src=\"figures/ControlWidgetParametrise.png\" width=\"150\"> \n",
+ " <img src=\"figures/ControlWidgetReset.png\" width=\"150\"> \n",
"</center>\n",
"<br>\n",
"\n",
- "Once your simulator entered the \"idle\" state, you can \"start\" your simulation \n",
+ "- If your simulator is in *idle* state, you can ***start* your simulation**\n",
"\n",
"<br>\n",
"<center>\n",
- " <img src=\"figures/ControlWidgetParametrise.png\" width=\"150\"> \n",
+ " <img src=\"figures/ControlWidgetPlay.png\" width=\"150\"> \n",
"</center>\n",
"<br>\n",
"\n",
- "Then, the simulator transits from \"starting\" to \"running\". This may take some time, depending on the workload of the cluster. Once, the simulation finishes, the simulator reaches the \"stopping\" state\n",
+ "- The **simulator transits its state** from *idle* to *starting* to *running*. If the simulation is finished, the simulator reaches the *stopping* state.\n",
"\n",
"<br>\n",
"<center>\n",
- " <img src=\"figures/ControlWidgetParametrise.png\" width=\"150\"> \n",
+ " <img src=\"figures/StateTransitions.png\" width=\"700\"> \n",
"</center>\n",
"<br>"
]
@@ -165,20 +161,37 @@
"cell_type": "markdown",
"metadata": {},
"source": [
- "## Simulation results retrieval, analysis\n",
+ "## How to obtain the simulation results?\n",
+ "\n",
+ "- If the simulator reached the *stopping* state, you can **obtain the results** by clicking on the *Python* button\n",
+ "\n",
+ "<br>\n",
+ "<center>\n",
+ " <img src=\"figures/ControlWidgetResults.png\" width=\"150\"> \n",
+ "</center>\n",
+ "<br>\n",
+ "\n",
+ "- Copy the result id and access token\n",
+ "\n",
+ "<br>\n",
+ "<center>\n",
+ " <img src=\"figures/CopyResultsCode.png\" width=\"300\"> \n",
+ "</center>\n",
+ "<br>\n",
+ "\n",
+ "- Go back to the **Jupyter case notebook**, e.g. [Case 1: Electromagnetic Phenomena of Synchronous Machines](./SLEW_Case1_Electromagnetic_Phenomena.ipynb). \n",
"\n",
- "- Observe the status of the simulator\n",
- "- How to get the code snippet to download the results to your Jupyter Notebook\n",
- "- How to plot the result"
+ "- **Insert your result id and access token** into the dedicated result download cell. That is, replace *1* and *'xyz'* in \n",
+ " `r = Result(1, 'xyz', endpoint='https://slew.rwth-aachen.de')` \n",
+ " with the actual id and token for your result, which you have just produced. Then you can execute the result download cell. Afterwards, you can proceed further to the cells for plotting the results."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
- "## Further info\n",
- "- Focus here on how to work with *SLEW - Individual Experiments*\n",
- "- Further info on how to handle *SLEW - Joint Experiments* can be found in the notebook [Playground: High Voltage Power System](./SLEW_Playground_HV_Power_System.ipynb)"
+ "## Further information\n",
+ "The focus is here on how to work with **SLEW - Individual Experiments**. Further info on how to handle **SLEW - Joint Experiments** can be found in the notebook [Playground: High Voltage Power System](./SLEW_Playground_HV_Power_System.ipynb)"
]
}
],
diff --git a/figures/ControlWidgetPlay.png b/figures/ControlWidgetPlay.png
new file mode 100644
index 0000000000000000000000000000000000000000..f09f0e824b8c5109712d0ab672f7c60b942a129f
Binary files /dev/null and b/figures/ControlWidgetPlay.png differ
diff --git a/figures/ControlWidgetReset.png b/figures/ControlWidgetReset.png
new file mode 100644
index 0000000000000000000000000000000000000000..120f2b4125cafb746ebbe49c3a7f7c5a2b621ea1
Binary files /dev/null and b/figures/ControlWidgetReset.png differ
diff --git a/figures/ControlWidgetResults.png b/figures/ControlWidgetResults.png
new file mode 100644
index 0000000000000000000000000000000000000000..bd6923eafc586395ae58731ab76207a45cdd2504
Binary files /dev/null and b/figures/ControlWidgetResults.png differ
diff --git a/figures/CopyResultsCode.png b/figures/CopyResultsCode.png
new file mode 100644
index 0000000000000000000000000000000000000000..2a922386e81f0a8521b0addc15abe4083aba42fe
Binary files /dev/null and b/figures/CopyResultsCode.png differ
diff --git a/figures/EnterNumericalValue.PNG b/figures/EnterNumericalValue.PNG
deleted file mode 100644
index 371cc368506c8de8b57e4b9104961aafba63953d..0000000000000000000000000000000000000000
Binary files a/figures/EnterNumericalValue.PNG and /dev/null differ
diff --git a/figures/EnterNumericalValue.png b/figures/EnterNumericalValue.png
new file mode 100644
index 0000000000000000000000000000000000000000..f3e9ac70564eccafbf9a507dfb1d8fb5a22df25e
Binary files /dev/null and b/figures/EnterNumericalValue.png differ
diff --git a/figures/ModifyParameter.PNG b/figures/ModifyParameter.PNG
deleted file mode 100644
index 15c587605823017ea00e6d2750d116724928f775..0000000000000000000000000000000000000000
Binary files a/figures/ModifyParameter.PNG and /dev/null differ
diff --git a/figures/ModifyParameter.png b/figures/ModifyParameter.png
new file mode 100644
index 0000000000000000000000000000000000000000..d339e9aaad067df746447ef2fbf0083daf7a6ed0
Binary files /dev/null and b/figures/ModifyParameter.png differ
diff --git a/figures/StateTransitions.png b/figures/StateTransitions.png
new file mode 100644
index 0000000000000000000000000000000000000000..95665f39970e65d522a391811bba852c1f708085
Binary files /dev/null and b/figures/StateTransitions.png differ