diff --git a/source/_static/checkin.png b/source/_static/checkin.png new file mode 100644 index 0000000..a3812a7 Binary files /dev/null and b/source/_static/checkin.png differ diff --git a/source/_static/classic.png b/source/_static/classic.png new file mode 100644 index 0000000..c0fce0e Binary files /dev/null and b/source/_static/classic.png differ diff --git a/source/_static/new-classic.png b/source/_static/new-classic.png new file mode 100644 index 0000000..f0ba1b3 Binary files /dev/null and b/source/_static/new-classic.png differ diff --git a/source/_static/training-front.png b/source/_static/training-front.png new file mode 100644 index 0000000..87139e6 Binary files /dev/null and b/source/_static/training-front.png differ diff --git a/source/data.rst b/source/data.rst index b9428e4..4c815d1 100644 --- a/source/data.rst +++ b/source/data.rst @@ -1,11 +1,10 @@ Data Management --------------- -10GB persistent storage for the notebooks is available as your home +1GB persistent storage for the notebooks is available as your home directory. **Please note that files stored on any other folder will be lost when your notebook server is closed (which can -happen if there is no activity for more than 1 hour!)**. There is no space -limit set for other folders. +happen if there is no activity for more than 1 hour!)**. If you need to increase your persistent storage space, open a `GGUS ticket to the Notebooks Support Unit `_ diff --git a/source/index.rst b/source/index.rst index ac7de71..b0804b0 100644 --- a/source/index.rst +++ b/source/index.rst @@ -35,6 +35,7 @@ or any additional service requests. integration communities technical + training faq .. to be added back diff --git a/source/training.rst b/source/training.rst new file mode 100644 index 0000000..2c286b8 --- /dev/null +++ b/source/training.rst @@ -0,0 +1,130 @@ +Training instance +----------------- + +EGI provides a training instance of the Notebooks service for training +events. This instance may not use the same software version as in +production and may not be always available. + +.. note:: + + The training environment for the Notebooks is available at + https://training.notebooks.egi.eu. + +To get started: + +#. Go to https://training.notebooks.egi.eu + +#. Start the authentication process by clicking on **Start your notebooks!** + button + + .. image:: /_static/training-front.png + + +#. Select the Identity Provider you belong to from the discovery page. If this + is the first time you access an EGI service, Check-in will guide you through + a registration process. + + .. image:: /_static/checkin.png + +#. You will see the Jupyter interface once your personal server is started + + .. image:: /_static/classic.png + + +Launching a notebook +==================== + +Click on the New > Python 3 option to launch your notebook with Python 3 +kernel. When you create this notebook, a new tab will be presented with a +notebook named `Untitled.ipynb`. You can easily rename it by right-clicking on +the current name. + + +.. image:: /_static/new-classic.png + +Structure of a notebook +::::::::::::::::::::::: + +The notebook consists of a sequence of cells. A cell is a multiline text input +field, and its contents can be executed by using ``Shift-Enter``, or by clicking +either the `"Play"` button in the toolbar, or Cell -> Run in the menu bar. + +The execution behaviour of a cell is determined by the cell’s type. + +There are three types of cells: cells, markdown, and raw cells. +Every cell starts off being a code cell, but its type can be changed by using +a drop-down on the toolbar (which will be “Code”, initially). + +Code cells +^^^^^^^^^^ + +A code cell allows you to edit and write new code, with full syntax +highlighting and tab completion. The programming language you use depends on +the kernel. + +When a code cell is executed, its content is sent to the kernel associated +with the notebook. The results that are returned from this computation are +then displayed in the notebook as the cell’s output. The output is not +limited to text, with many other possible forms of output are also possible, +including figures and HTML tables. + +Markdown cells +^^^^^^^^^^^^^^ + +You can document the computational process in a literate way, alternating +descriptive text with code, using rich text. This is accomplished by +marking up text with the Markdown language. The corresponding cells are +called Markdown cells. The Markdown language provides a simple way to +perform this text markup, that is, to specify which parts of the text should +be emphasized (italics), bold, form lists, etc. + +If you want to provide structure for your document, you can also use markdown +headings. Markdown headings consist of 1 to 6 hash `#` signs followed by a +space and the title of your section. The markdown heading will be converted +to a clickable link for a section of the notebook. It is also used as a hint +when exporting to other document formats, like PDF. + +When a Markdown cell is executed, the Markdown code is converted into the +corresponding formatted rich text. Markdown allows arbitrary HTML code for +formatting. + +Raw cells +^^^^^^^^^ + +Raw cells provide a place in which you can write output directly. Raw cells +are not evaluated by the notebook. + + +Keyboard shortcuts +:::::::::::::::::: + +All actions in the notebook can be performed with the mouse, but keyboard +shortcuts are also available for the most common ones. These are some of the +most common: + +* ``Shift-Enter``: run cell. Execute the current cell, show any output, + and jump to the next cell below. If ``Shift-Enter`` is invoked on the last + cell, it creates a new cell below. This is equivalent to clicking the + Cell -> Run menu item, or the Play button in the toolbar. + +* ``Esc``: Command mode. In command mode, you can navigate around the notebook + using keyboard shortcuts. + +* ``Enter`` : Edit mode. In edit mode, you can edit text in cells. + +Hands-on +======== + +We pre-populate your home directory with some sample notebooks to get started, +below you can find links to other notebooks that we have used in past trainings +that may be useful to explore the system: + +#. `A very basic notebook to get started `_ + +#. `Getting data and doing a simple plot `_. + +#. `Connect to NOAA's GrADS Data Server to plot wind speed `_. + +#. `Installing new libraries `_. + +#. `Interact with Check-in `_