Skip to content

Commit

Permalink
Merge branch 'main' into storage
Browse files Browse the repository at this point in the history
  • Loading branch information
enolfc authored Dec 18, 2024
2 parents f6663ee + e2d92a2 commit 51ff047
Show file tree
Hide file tree
Showing 9 changed files with 52 additions and 36 deletions.
3 changes: 0 additions & 3 deletions .github/linters/mlc_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@
{
"pattern": "^http://cvmfs-release01.gridpp.rl.ac.uk/*"
},
{
"pattern": "^https://training.notebooks.egi.eu*"
},
{
"pattern": "^https://goc.egi.eu/portal*"
},
Expand Down
12 changes: 11 additions & 1 deletion content/en/users/dev-env/notebooks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ EGI Notebooks provides the well-known Jupyter interface for notebooks, with the
following added features:

- Integration with [EGI Check-in](../../aai/check-in/) allows you to login with
any EduGAIN or social accounts (e.g. Google, Facebook)
any eduGAIN or social accounts (e.g. Google, Facebook)
- Persistent storage associated with each user is available in the notebooks
environment
- Customisable with new notebook environments, expose any existing notebook to
Expand Down Expand Up @@ -86,3 +86,13 @@ EGI currently operates community instances for:
[EOSC-Pillar](https://eosc-pillar.d4science.org/). Check with
[D4Science support](https://www.d4science.org/contact-us) for more
information.

### Training instance

EGI can provide a custom and temporary instance of the Notebooks service for
training events, if you have a specific event where you would like to use EGI
Notebooks as platform for your training, [let us know](../../../support/).

{{% alert title="Note" color="warning" %}}This instance may not use the same
software version as in production and may not be always available, as it is
typically configured only for specific training events. {{% /alert %}}
Original file line number Diff line number Diff line change
@@ -1,48 +1,58 @@
---
title: Notebooks Training Instance
title: Training Instance
weight: 30
title: Notebooks Quick Start
weight: 1
type: docs
aliases:
- /users/notebooks/training
description: >
Notebooks for training events
Getting started with EGI Notebooks
---

EGI provides a training instance of the Notebooks service for training events.
The Notebooks Service is based on [JupyterHub](https://jupyter.org/hub). It
enables remote use of [Jupyter Notebooks](https://jupyter.org/) in a managed
environment integrated with other EGI services. Notebooks main interface uses
[JupyterLab](https://jupyterlab.readthedocs.io), a highly extensible environment
for running and authoring computational notebooks.

To get started:
You can find links below to the upstream documentation of the EGI Notebooks
components:

1. Go to <https://training.notebooks.egi.eu>.
- [JupyterLab Documentation](https://jupyterlab.readthedocs.io) for use of the
integrated user environment (menus, working tabs, etc.)
- [JupyterHub Documentation](https://jupyterhub.readthedocs.io/en/latest/) to
manage your remote resources (starting and stopping servers, collaborative
sharing, etc.)
- Documentation for your core programming languages:
- [Python](https://docs.python.org/)
- [Julia](https://docs.julialang.org/)
- [R](https://cran.r-project.org/doc/manuals/r-release/R-intro.html)
- [Octave](https://docs.octave.org/latest/)

{{% alert title="Note" color="warning" %}} This instance may not use the same
software version as in production and may not be always available, as it is
typically configured only for specific training events. {{% /alert %}}
## Getting Started

1. Start the authentication process by clicking on **Start your notebooks!**
button
1. Start by [creating an EGI account](../../../aai/check-in/signup)
1. Then enroll
[vo.notebooks.egi.eu VO](https://aai.egi.eu/registry/co_petitions/start/coef:111)
1. Go to [https://notebooks.egi.eu/](https://notebooks.egi.eu/)
1. Start the authentication process by clicking on **Continue with EGI
Check-in!** button

![image](training-front.png)
![Notebooks welcome page](notebooks-front.png)

1. 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.
1. Once logged in, you will prompted to select the [environment](../kernels/),
pick the "Default EGI environment"
1. Click on "Start" to get your JupyterLab instance You will see the Jupyter
interface once your personal server is started

![Check-in auth](checkin.png)

1. You will see the Jupyter interface once your personal server is started

![Classic Jupyter Notebook](classic.png)
![JupyterLab](lab.png)

## Launching a notebook

Click on the New \> Python 3 option to launch your notebook with Python 3
Click on the "Python 3 (ipykernel)" 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.

![New notebook](new-classic.png)

### Structure of a notebook

The notebook consists of a sequence of cells. A cell is a multiline text input
Expand Down Expand Up @@ -104,14 +114,13 @@ most common:
using keyboard shortcuts.
- `Enter` : Edit mode. In edit mode, you can edit text in cells.

## Hands-on
## Tutorials

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:
You can find links to sample notebooks that we have used in past trainings that
may be useful to explore the system:

1. [A very basic notebook to get started](https://github.com/EGI-Federation/training-notebooks-di4r-2018/blob/master/00-first-notebook.ipynb)
2. [Getting data and doing a simple plot](https://github.com/EGI-Federation/training-notebooks-climate-change/blob/master/cckp_historical_temperature.ipynb).
3. [Connect to NOAA\'s GrADS Data Server to plot wind speed](https://github.com/EGI-Federation/training-notebooks-di4r-2018/blob/master/02-wind-nowcast.ipynb).
4. [Installing new libraries](https://github.com/EGI-Federation/training-notebooks-di4r-2018/blob/master/03-customizing.ipynb).
5. [Interact with Check-in](https://github.com/EGI-Federation/training-notebooks-di4r-2018/blob/master/04-check-in.ipynb)
1. [Getting data and doing a simple plot](https://github.com/EGI-Federation/training-notebooks-climate-change/blob/master/cckp_historical_temperature.ipynb).
1. [Connect to NOAA\'s GrADS Data Server to plot wind speed](https://github.com/EGI-Federation/training-notebooks-di4r-2018/blob/master/02-wind-nowcast.ipynb).
1. [Installing new libraries](https://github.com/EGI-Federation/training-notebooks-di4r-2018/blob/master/03-customizing.ipynb).
1. [Interact with Check-in](https://github.com/EGI-Federation/training-notebooks-di4r-2018/blob/master/04-check-in.ipynb)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 comments on commit 51ff047

Please sign in to comment.