Update intro page and add missing titles (#227)

* add titles and fix intro page * remove any reference to Slack * Update intro.ipynb Co-authored-by: Aliaksandr Yakutovich <yakutovicha@gmail.com> * remove image of old output --------- Co-authored-by: Aliaksandr Yakutovich <yakutovicha@gmail.com>
empa-scientific-it · May 3, 2024 · 8b68500 · 8b68500
1 parent 8b97aac
commit 8b68500
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 75 deletions.
diff --git a/FAQ.md b/FAQ.md
@@ -2,7 +2,7 @@
 
 ## What will be the workshop schedule?
 
-Each tutorial session lasts 4 half-days, from 9:00 to 13:00 (breaks included). During one afternoon, a one hour and a half will be dedicated to the extra session on Linux & Gitlab.
+Each topic lasts 2 hours and includes a walk-through of the theoretical concepts, a hands-on session and Q&A. At the end of each day we will have 1 extra hour to answer additional questions.
 
 ## Which operating system should I use?
 
@@ -14,23 +14,27 @@ There is no specific software that you have to install before the training. Howe
 
 ## Is there a recommended Python installation?
 
-If you plan to install Python locally, we recommend using Python 3.8 at the minimum. If possible, it's better to have Python 3.10 installed. If you need help, please check out the `#help` channel on Slack and feel free to ask for support.
+If you plan to install Python locally, we recommend using Python 3.8 at the minimum. If possible, it's better to have Python 3.10 installed.
 
 ## Will the workshop cover the topic X?
 
 The workshop will cover the fundamentals of the language, and the topics we will explore include:
 
+Basic:
 - Basic syntax and data types
 - Control flow, loops, and exceptions
 - Functions
 - File handling
-- Functional programming
 - Object-oriented programming
 - Modules and packages
 
-We have created dedicated channels on Slack for each topic.
-
-Due to time constraints, we couldn't fit all the requests, and we will mainly focus on the fundamentals of the language. However, you will see some practical use cases during the exercise sessions. If you have any questions or are interested in a specific topic that is not covered in the workshop, you can open a discussion on the `#extra` channel on Slack.
+Advanced:
+- Manage Python project
+- Advanced functions
+- Functional programming
+- Advanced Object-oriented programming
+- Parallelism and concurrency
+- Libraries
 
 ## How do I test my solutions?
 
@@ -55,11 +59,8 @@ To run the cell and test your solution, select it and press `Shift + Enter`  or
 
 ## I have another question. Where should I ask?
 
-For any other question you might have about the workshop, feel free to post a message in the `#help` channel on Slack.
-
-A couple of things worth reminding about Slack:
+For any other question you might have about the workshop, feel free to post a message in the `discussions` on GitHub.
 
-1. Do a quick search in the channel before posting. It might be that someone already started a discussion on the same topic.
-2. **Always** reply within [threads](https://slack.com/help/articles/115000769927-Use-threads-to-organize-discussions-) (or open a new one) when you want to join a conversation. The [purpose](https://slack.com/resources/using-slack/tips-on-how-best-to-use-threaded-messages) is to avoid too many unrelated messages that are difficult to navigate in the long run.
+If you come across any bug or have suggestions on how we could improve the content and exercises, feel free to open a new `issue`.
 
-For a few more tips about using Slack effectively, check out [this link](https://slack.com/blog/collaboration/etiquette-tips-in-slack).
+Here is the link to the tutorial's [official repository on GitHub](https://github.com/empa-scientific-it/python-tutorial).
diff --git a/functional_programming.ipynb b/functional_programming.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Functional Programming"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

diff --git a/input_output.ipynb b/input_output.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Input / Output"
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",

diff --git a/intro.ipynb b/intro.ipynb
@@ -7,13 +7,6 @@
     "# Introduction to the tutorial"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Table of Contents"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {
@@ -45,24 +38,19 @@
    "source": [
     "# Welcome! 🐍\n",
     "\n",
-    "Hello and welcome, everyone! We’re excited that you chose to embark in this Python journey\n",
+    "Hello and welcome, everyone! We’re excited that you chose to embark in this Python journey.\n",
     "\n",
-    "Over **four** days, we'll see a lot of Python. **Two** topics each day\n",
+    "Over **three** days, we'll see a lot of Python. **Two** topics each day:\n",
     "\n",
     "### Day 1\n",
-    "1. Introduction to the course\n",
-    "2. Basic syntax and data types\n",
+    "1. Basic syntax and data types\n",
+    "2. Control flow, loops, and exceptions\n",
     "\n",
     "### Day 2\n",
-    "1. Control flow, loops, and exceptions\n",
-    "2. Functions\n",
-    "\n",
+    "1. Functions\n",
+    "2. Working with files\n",
     "\n",
     "### Day 3\n",
-    "1. Working with files\n",
-    "2. Functional programming\n",
-    "\n",
-    "### Day 4\n",
     "1. Object-oriented programming\n",
     "2. Modules and packages\n",
     "\n",
@@ -77,13 +65,13 @@
    "source": [
     "# Timetable\n",
     "\n",
-    "We'll be following the following schedule for each day:\n",
+    "Here is the schedule we'll be following each day:\n",
     "\n",
-    "- 8:45-9:00 — Welcome, warm-up questions\n",
-    "- 9:00-10:50 — Topic 1 (theory, hands-on, Q&A)\n",
-    "- *10:50-11:10 — Break* ☕\n",
-    "- 11:10-13:00 — Topic 2\n",
-    "- 🥪 – Practice – Offline discussions on Slack"
+    "- 9:30-10:00 — Welcome coffee\n",
+    "- 10:00-12:00 — Topic 1 (theory, hands-on, Q&A)\n",
+    "- *12:00-13:00 — Lunch Break*\n",
+    "- 13:00-15:00 — Topic 2 (theory, hands-on, Q&A)\n",
+    "- 15:00-16:00 — Practice, discussions and additional Q&A"
    ]
   },
   {
@@ -93,22 +81,14 @@
     "# How to interact\n",
     "\n",
     "Each block will contain both theory and hands-on.\n",
-    "It's an online workshop, so interaction between us is **essential**.\n",
-    "\n",
-    "A few tips to interact:\n",
+    "Remember that interaction between us is **essential**.\n",
+    "We encourage you to actively participate and ask questions.\n",
     "\n",
-    "## On Zoom\n",
-    "- Raise your hand 🤚 then ask.\n",
-    "- Write in the chat.\n",
-    "- We will open a break-out room to address long questions. **Anyone** interested can jump in.\n",
+    "## On GitHub\n",
+    "- For any other question you might have about the workshop, feel free to post a message in the [discussions](https://github.com/empa-scientific-it/python-tutorial/discussions).\n",
+    "- If you come across any bug or have suggestions on how we could improve the content and exercises, feel free to open a new [issue](https://github.com/empa-scientific-it/python-tutorial/issues).\n",
     "\n",
-    "\n",
-    "## On Slack\n",
-    "- Ask your question in the **corresponding channel**. Use `#help` for generic questions.\n",
-    "- Reply **in a thread** if you want to add a comment to a question.\n",
-    "- Use `@Sasha`, `@Simone`, `@Edoardo` if you want to mention the tutorial instructors directly.\n",
-    "\n",
-    "Although the chat will be distributed together with the recording, Slack is much better suited to hold continued Q&A and other discussions.\n",
+    "GitHub is much better suited to hold continued Q&A and other discussions, even after the tutorial ends.\n",
     "Please, use it."
    ]
   },
@@ -124,9 +104,7 @@
     "\n",
     "Binder is a service that allows you to run Jupyter Notebooks in the cloud.\n",
     "It's free and requires no installation.\n",
-    "You can use it by clicking on the link in the `#announcements` channel on Slack.\n",
-    "Also, you can find the `launch|binder` button on the main page of the [official repository on GitHub](https://github.com/empa-scientific-it/python-tutorial) of the tutorial.\n",
-    "We will also share the link on Slack in `#announcements` channel and in Zoom's chat\n",
+    "You can use it by clicking the `launch|binder` button on the main page of the [official repository on GitHub](https://github.com/empa-scientific-it/python-tutorial) of the tutorial.\n",
     "\n",
     "Once you click on the link, you will be redirected to the startup page of Binder, which looks like this:\n",
     "\n",
@@ -404,11 +382,9 @@
    "source": [
     "As you can see, the message quite clearly tells you that the solution is wrong.\n",
     "\n",
-    "The tests that are run on your solution also give you an hint on the **expected result**. Look at the following image, an excerpt of the output above:\n",
-    "\n",
-    "![Error summary](images/error_test_info.png)\n",
+    "The tests that are run on your solution also give you an hint on the **expected result**. You need to revisit your code and try to understand what went wrong.\n",
     "\n",
-    "For example, the first line `assert 4 == -2` means the test was expecting `4`, while your code returned `-2`. You need to revisit your code and try to understand what went wrong.\n",
+    "After 3 failed attempts, a proposed solution will be revealed.\n",
     "\n",
     "<div class=\"alert alert-block alert-warning\">\n",
     "<b>Important:</b> The input arguments or the expected results of an exercise can be <strong>quite long</strong>. The output of the tests might be a bit difficult to navigate. If you need help with that, just <strong>ask</strong> 😉.\n",
@@ -439,8 +415,8 @@
     "</div> \n",
     "\n",
     "\n",
-    "Remember: **ask** if you need help, either on Zoom or Slack.\n",
-    "These four days should be a practical workshop where we can answer to most of your questions you have as a beginner Python user.\n",
+    "Remember: **ask** if you need help.\n",
+    "These days should be a practical workshop where we can answer to most of your questions you have as a beginner Python user.\n",
     "Let's make the most out of this time!"
    ]
   },
@@ -466,22 +442,7 @@
    "source": [
     "# Hands-on sessions\n",
     "\n",
-    "There will be plenty of time to work on the exercises.\n",
-    "\n",
-    "Here's how these time slots will be organized **on Zoom**:\n",
-    "\n",
-    "## Main room\n",
-    "\n",
-    "- Anyone who is not yet comfortable with Python.\n",
-    "- Walkthrough of a few challenging exercises.\n",
-    "- **Interactive**: you should participate with suggestions.\n",
-    "\n",
-    "\n",
-    "## Break-out rooms\n",
-    "\n",
-    "- Anyone who wants to work on their own.\n",
-    "- Discussion with someone who wants to share their code.\n",
-    "- Specific Q&A."
+    "There will be plenty of time to work on the exercises."
    ]
   },
   {

diff --git a/modules_and_packages.ipynb b/modules_and_packages.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Modules and Packages"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},