diff --git a/SLEW_Platform_Tutorial.ipynb b/SLEW_Platform_Tutorial.ipynb index 119ef0bb82af79ce57cef88a4932078ee6732905..6dda055dbde4c11e51287bac2e3579ad033df26a 100644 --- a/SLEW_Platform_Tutorial.ipynb +++ b/SLEW_Platform_Tutorial.ipynb @@ -4,24 +4,91 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "<div>\n", + "<center>\n", " <img src=\"figures/slew_logo.png\" style=\"float: right;height: 15em;\">\n", - "</div>\n", + "</center>\n", "\n", "# SLEW Platform Tutorial\n", "\n", - "## Login, Scenarios, Dashboards\n", - "- How to access VILLASweb\n", - " - Platform URL: [https://slew.rwth-aachen.de/](https://slew.rwth-aachen.de/)\n", - " - Log-in procedure via JupyterHub\n", - "- How to choose scenario and dashboard \n", - " - Each user has two **scenarios**: \n", - " - `SLEW - Individual Experiments`\n", - " - `SLEW - Joint Experiments`\n", - " - Each scenario can have multiple **dashboards**, e.g. the scenario *SLEW - Individual Experiments* has two dashboards:\n", - " - `Case 1: Electromagnetic Phenomena of Synchronous Machines`\n", - " - `Case 2: Electromechanical Phenomena of Synchronous Machines`\n", - "- Navigate to the dashboard `Case 1: Electromagnetic Phenomena of Synchronous Machines` of the scenario `SLEW - Individual Experiments`" + "**VILLASweb** is the graphical user interface of the **SLEW** platform. \n", + "It enables you to control and interact with the simulations.\n", + "\n", + "## 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 button \"Sign in with JupyterHub\" \n", + "\n", + "<br>\n", + "<center>\n", + " <img src=\"figures/LoginButton.png\" width=\"250\"> \n", + "</center>\n", + "<br>\n", + "\n", + "- Enable **VILLASweb** reuse your **JupyterHub** authentication by clicking on \"Authorize\" \n", + "\n", + "<br>\n", + "<center>\n", + " <img src=\"figures/AuthorizeAccess.png\" width=\"400\"> \n", + "</center>\n", + "<br>\n", + "\n", + "- Then, you enter the startpage of **VILLASweb** \n", + "\n", + "<br>\n", + "<center>\n", + " <img src=\"figures/VILLASwebStartpage.png\" width=\"300\"> \n", + "</center>\n", + "<br>" + ] + }, + { + "cell_type": "markdown", + "metadata": { + "tags": [] + }, + "source": [ + "***\n", + "## How to choose the scenario?\n", + "\n", + "Each user has two scenarios: \n", + " 1. `SLEW - Individual Experiments` \n", + " 2. `SLEW - Joint Experiments` \n", + "\n", + "- Navigate to \"Scenarios\"\n", + "\n", + "<br>\n", + "<center>\n", + " <img src=\"figures/VILLASwebStartpageScenarios.png\" width=\"300\"> \n", + "</center>\n", + "<br>\n", + "\n", + "- Choose `SLEW - Individual Experiments` to reach the individual, isolated working space created for you:\n", + " \n", + "<br>\n", + "<center>\n", + " <img src=\"figures/VILLASwebScenarios.png\" width=\"250\"> \n", + "</center>\n", + "<br>\n" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "***\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", + "\n", + "- Navigate to the dashboard `Case 1: Electromagnetic Phenomena of Synchronous Machines`:\n", + "\n", + "<br>\n", + "<center>\n", + " <img src=\"figures/VILLASwebDashboardCase1.png\" width=\"250\"> \n", + "</center>\n", + "<br>" ] }, { @@ -30,6 +97,7 @@ "tags": [] }, "source": [ + "***\n", "## Simulation parametrisation, execution\n", "\n", "- Player widget to adapt and run simulation\n", diff --git a/figures/AuthorizeAccess.png b/figures/AuthorizeAccess.png new file mode 100644 index 0000000000000000000000000000000000000000..f384efef3b033e12242697e4f896aae5ce96e125 Binary files /dev/null and b/figures/AuthorizeAccess.png differ diff --git a/figures/LoginButton.png b/figures/LoginButton.png new file mode 100644 index 0000000000000000000000000000000000000000..57326431084f8d31cfcbb28e525adaf1f1800ce0 Binary files /dev/null and b/figures/LoginButton.png differ diff --git a/figures/VILLASwebDashboardCase1.png b/figures/VILLASwebDashboardCase1.png new file mode 100644 index 0000000000000000000000000000000000000000..b00df1a573db66d8a8d44cab89341ecd86507168 Binary files /dev/null and b/figures/VILLASwebDashboardCase1.png differ diff --git a/figures/VILLASwebScenarios.png b/figures/VILLASwebScenarios.png new file mode 100644 index 0000000000000000000000000000000000000000..39c3034b5527fac7571ff50d6cca4f3398f2627a Binary files /dev/null and b/figures/VILLASwebScenarios.png differ diff --git a/figures/VILLASwebStartpage.png b/figures/VILLASwebStartpage.png new file mode 100644 index 0000000000000000000000000000000000000000..9cc094474f908a433c25f542b43481e44f771c3c Binary files /dev/null and b/figures/VILLASwebStartpage.png differ diff --git a/figures/VILLASwebStartpageScenarios.png b/figures/VILLASwebStartpageScenarios.png new file mode 100644 index 0000000000000000000000000000000000000000..ec31eba4c0abd0401df97dbcd82fc7bacf3d1488 Binary files /dev/null and b/figures/VILLASwebStartpageScenarios.png differ