Tutorials

We provide jupyerlab based tutorials in the tutorials repository of themachinethatgoesping. The repository still needs some cleaning, please be patient and concentrate on the demo folder for now.

Install tutorials and requirements

To run the tutorials you need to install ping first. You can find the installation instructions here. First clone the tutorials repository using your favorite git application or the following command:

$ git clone https://github.com/themachinethatgoesping/tutorials.git

A requirements file is provided in the repository. However, we recommend installing the requirements using poetry to ensure all packages are on a version that was tested. You can install the tutorial requirements using the following command:

miniforge / poetry

# first enter the tutorials directory
$ cd tutorials

# Here we assume that you are using miniforge / mamba and created and environment called "ping"
$ mamba activate -n ping

# install poetry
$ pip install poetry

# install the requirements fixed in the pyproject.toml and the poetry.lock file
$ poetry install

anaconda / poetry

# first enter the tutorials directory
$ cd tutorials

# Here we assume that you are using conda and created and environment called "ping"
$ conda activate -n ping

# install poetry
$ pip install poetry

# install the requirements fixed in the pyproject.toml and the poetry.lock file
$ poetry install

anaconda / conda

# first enter the tutorials directory
$ cd tutorials

# Here we assume that the name of the environment is "ping"
$ conda activate -n ping

# if you want to update the package use
$ conda install --file requirements.txt

minforge / mamba

# first enter the tutorials directory
$ cd tutorials

# Here we assume that the name of the environment is "ping"
$ mamba activate -n ping

# if you want to update the package use
$ mamba install --file requirements.txt

pip

# first enter the tutorials directory
$ cd tutorials

# if you want to update the package use
$ pip install -r requirements.txt

Run tutorials

You can find the tutorials in the demo folder of the tutorials repository. To open jupyerlab in the demo folder, you can use the following command in the terminal/miniforge prompt:

$ mamba activate -n ping

$ cd tutorials/demo

$ jupyter lab .

The last prompt will open a jupyter lab instance in your browser. You can now open the tutorials and run them.