Incubator Digital Twin Course

This repository hosts the materials that guide the reader into building a digital twin for the incubator project.

The idea is to give a step by step guide with examples on how to build a digital twin for an incubator.

Each module is in a separate folder, containing one or more Jupyter notebooks. It is strongly recommended that modules and jupyter notebooks are followed in order, as they sometimes depend on each other.

Contents

• Incubator Digital Twin Course
  • Contents
  • Questions and Issues
  • Pre-Requisites
    • Git
    • Python
    • VSCode
    • Jupyter
    • Jupyter VSCode Extension
    • Docker
    • RabbitMQ
    • InfluxDB
  • Course Organization and Activities Index
  • Repository Maintenance
  • Frequently Asked Questions
    • Example question

Questions and Issues

If you encounter any problem, or have any questions, follow the steps:

1. Consult the Frequently Asked Questions.
2. Check if there are closed or open issues
3. Open an issue.
4. Contact Claudio who is the course responsible.

Pre-Requisites

We assume the reader is familiar with the following tools (material are provided below for tutorials, but we recommend the reader to search the web for the latest information):

1. Git
2. Python
3. Jupyter
4. VSCode
5. Docker
6. RabbitMQ
7. InfluxDB

Git

Installation:

1. Depending on your platform, you may have to install the git binary, and then a git graphical user interface.
2. The git binary can be obtained here, for your platform: https://git-scm.com/
3. The git user interface can be found here: https://git-scm.com/downloads/guis
   1. For windows, we recommend:
      1. https://git-scm.com/downloads/guis
   2. For mac, we recommend:
      1. https://docs.github.com/en/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop
   3. For Linux, we recommend:
      1. TODO

Tutorial: https://github.com/git-guides

Python

We will use python as the main programming language for creating the digital twin, due to its wide usage, versatility, and excellent library support.

Installation:

1. Use Python 3.11 as minimum version. We recommend to install the latest python version, and revert to the suggested version if you face problems.
2. Install the python dependencies declared in the requirements.txt file. Run pip install -r requirements.txt

Tutorial:

1. https://docs.python.org/3.11/tutorial/index.html
2. Learn about virtual environments and the pip package manager to install python packages: https://docs.python.org/3.11/tutorial/venv.html

VSCode

Installation:

1. https://code.visualstudio.com/docs/setup/setup-overview
2. Install the extensions:
   1. Python
   2. Jupyter - Running and visualizing Jupyter notebooks
   3. Markdown All in One - Visualizing the markdown documentation

Tutorial: https://code.visualstudio.com/docs/introvideos/basics

Jupyter

Installation:

1. Install Jupyter notebook following instructions from: https://jupyter.org/install

Tutorial:

1. Skim https://docs.jupyter.org/en/latest/
2. Learn about the Jupyter notebook, which is the interface we recommend for editing jupyter notebooks: https://jupyter-notebook.readthedocs.io/en/latest/

Jupyter VSCode Extension

Installation:

1. https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter

Tutorial:

1. Read the documentation in https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter
2. If the extension is installed, you should be able to open the notebooks in this repository using VSCode, and interact with them.

Docker

Installation: https://www.docker.com/products/docker-desktop/

Tutorial:

1. Start on the materials under 0-Pre-requisites
2. Complement them with https://docker-curriculum.com/

RabbitMQ

Installation: Not needed, since we will configure and run a rabbitmq server using docker.

Tutorial:

1. Start on the materials under 0-Pre-requisites
2. Complement them with the python tutorials in https://www.rabbitmq.com/tutorials

InfluxDB

Installation: Not needed, since we will configure and run an influxdb server using docker.

Tutorial:

1. Start on the materials under 0-Pre-requisites
2. Complement them with https://docs.influxdata.com/influxdb/v2/get-started/

Course Organization and Activities Index

The course is organized in different folders, to be followed in their alphanumerical order. Each folder contains one or more jupyter notebooks that you should run and go carefully over.

Repository Maintenance

1. Ensure that documentation links are not broken.
   1. Use for example, markdown-link-check to check all md files for broken links:

      Get-ChildItem -Include *.md -Recurse | Foreach {markdown-link-check --config .\markdown_link_check_config.json $_.fullname}

   2. If relevant, regenerate the Table of Contents, either by hand or (recommended) using Markdown All in One or some other utility.
2. Run notebooks and check that there are no errors:

    run_tests.ps1

Frequently Asked Questions

Example question