Merge branch 'main' into exercise-1-yingxing

0_Installation.ipynb

@@ -22,29 +22,39 @@
    "metadata": {},
    "source": [
     "## Software and material\n",
-    "What you need for the workshop (quick overview):\n",
+    "The course requires various things: a working installation of [Julia 1.9](https://julialang.org/downloads/), [Jupyter](https://jupyter.org/), [IJulia.jl](https://github.com/JuliaLang/IJulia.jl), the course material and various dependencies. To get everything follow these steps:\n",
     "\n",
-    "- [Julia 1.9](https://julialang.org/downloads/)\n",
-    "- [Jupyter](https://jupyter.org/) and [IJulia.jl](https://github.com/JuliaLang/IJulia.jl)\n",
-    "- This repository of workshop materials\n",
-    "- All required dependencies (Julia packages) for the workshop\n",
-    "\n",
-    "### Getting Julia\n",
-    "For following the course you will need at least Julia 1.6, but for full compatibility **Julia 1.8** is recommended.\n",
+    "### 1) Getting Julia\n",
+    "For following the course you will need **Julia 1.9**.\n",
     "Julia can be easily obtained in binary form from [Julia downloads](https://julialang.org/downloads/).\n",
     "\n",
-    "### Getting all the rest\n",
-    "The easiest way to get the remaining files and dependencies\n",
-    "is to [download the install.jl script](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/blob/main/install.jl?ref_type=heads) and run it from julia. See the instructions [on the github repository](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/).\n",
+    "### 2) Getting all the rest\n",
+    "\n",
+    "To get the remaining files and dependencies start up `julia` and in the resulting REPL shell, copy and paste the following:\n",
+    "```julia\n",
+    "import Downloads\n",
+    "script = Downloads.download(\"https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads\")\n",
+    "include(script)\n",
+    "```\n",
+    "This [downloads the install.jl script](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads) and runs it from julia.\n",
+    "\n",
+    "### 2) Getting all the rest (expert version)\n",
     "\n",
-    "As an alternative you can also also run the following commands manually\n",
-    "(this requires to have `git` and `julia` available from the commandline):\n",
+    "As an alternative you can also also run the following commands manually (this requires to have `git` and `julia` available from the commandline): \n",
     "```\n",
     "git clone https://gitlab.mathematik.uni-stuttgart.de/stammbn/Julia-seminar/\n",
     "cd Julia-seminar\n",
     "julia install-manual.jl\n",
     "```\n",
     "\n",
+    "### 3) Starting the notebook\n",
+    "To start the notebook make sure to be in the folder `Julia-seminar` and then run `julia`: an interactive Julia command line will open. In there run this command\n",
+    "\n",
+    "```\n",
+    "using IJulia; notebook(dir=pwd())\n",
+    "```\n",
+    "and the notebook will automatically open in a browser.\n",
+    "\n",
     "### Troubleshooting\n",
     "If you are facing issues, check out\n",
     "the [great troubleshooting section](https://carstenbauer.github.io/WorkshopWizard.jl/dev/troubleshooting/)\n",
@@ -57,31 +67,41 @@
    "metadata": {},
    "source": [
     "## Software und Material\n",
-    "Was du für das Seminar brauchst (schneller Überblick):\n",
-    "\n",
-    "- [Julia 1.9](https://julialang.org/downloads/)\n",
-    "- [Jupyter](https://jupyter.org/) und [IJulia.jl](https://github.com/JuliaLang/IJulia.jl)\n",
-    "- Dieses Repository mit den Workshop-Materialien\n",
-    "- Alle benötigten Abhängigkeiten (Julia-Pakete) für das Seminar\n",
+    "Der Kurs erfordert verschiedene Dinge: eine funktionierende Installation von [Julia 1.9](https://julialang.org/downloads/), [Jupyter](https://jupyter.org/), [IJulia.jl](https://github.com/JuliaLang/IJulia.jl), das Kursmaterial und verschiedene Abhängigkeiten. Um alles zu bekommen, befolgen Sie diese Schritte:\n",
     "\n",
-    "### Julia herunterladen\n",
-    "Um dem Kurs zu folgen, benötigst du mindestens Julia 1.6, aber für volle Kompatibilität wird **Julia 1.8** empfohlen.\n",
+    "### 1) Julia herunterladen\n",
+    "Um dem Kurs zu folgen, benötigst du **Julia 1.9**.\n",
     "Julia kann leicht in binärer Form von den [Julia-Downloads](https://julialang.org/downloads/) bezogen werden.\n",
     "\n",
-    "### Alles andere herunterladen\n",
-    "Die einfachste Möglichkeit, die verbleibenden Dateien und Abhängigkeiten zu erhalten, ist das [install.jl-Skript herunterzuladen](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/blob/main/install.jl?ref_type=heads) und es von Julia auszuführen. Siehe die Anweisungen [im GitHub-Repository](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/).\n",
+    "### 2) Alles andere herunterladen\n",
     "\n",
-    "Alternativ kannst du auch die folgenden Befehle manuell ausführen\n",
-    "(dies setzt voraus, dass `git` und `julia` von der Kommandozeile aus verfügbar sind):\n",
+    "Um die verbleibenden Dateien und Abhängigkeiten zu erhalten, starte `julia` und kopiere im resultierenden REPL-Shell folgenden Code:\n",
+    "```julia\n",
+    "import Downloads\n",
+    "script = Downloads.download(\"https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads\")\n",
+    "include(script)\n",
+    "```\n",
+    "Das [lädt das install.jl-Skript herunter](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads) und führt es in Julia aus.\n",
+    "\n",
+    "### 2) Den Rest bekommen (Experten-Version)\n",
+    "\n",
+    "Als Alternative können Sie auch die folgenden Befehle manuell ausführen (dies setzt voraus, dass `git` und `julia` von der Kommandozeile aus verfügbar sind):\n",
     "```\n",
     "git clone https://gitlab.mathematik.uni-stuttgart.de/stammbn/Julia-seminar/\n",
     "cd Julia-seminar\n",
     "julia install-manual.jl\n",
     "```\n",
     "\n",
+    "### 3) Starten des Notebooks\n",
+    "Um das Notebook zu starten, stellen Sie sicher, dass Sie sich im Ordner `Julia-seminar` befinden, und führen Sie dann `julia` aus: Eine interaktive Julia-Befehlszeile wird geöffnet. Führen Sie darin folgenden Befehl aus:\n",
+    "\n",
+    "```\n",
+    "using IJulia; notebook(dir=pwd())\n",
+    "```\n",
+    "und das Notebook wird automatisch im Browser geöffnet.\n",
     "\n",
     "### Fehlerbehebung\n",
-    "Wenn du auf Probleme stößt, schau dir den [ausgezeichneten Abschnitt zur Fehlerbehebung](https://carstenbauer.github.io/WorkshopWizard.jl/dev/troubleshooting/) des WorkshopWizard-Pakets von Carsten Bauer an (das von `install.jl` verwendet wird)."
+    "Wenn Sie auf Probleme stoßen, werfen Sie einen Blick auf den [ausgezeichneten Problembehandlungsabschnitt](https://carstenbauer.github.io/WorkshopWizard.jl/dev/troubleshooting/) aus dem WorkshopWizard-Paket von Carsten Bauer (das von `install.jl` verwendet wird)."
    ]
   },
   {
@@ -120,19 +140,11 @@
     "    push!(p, x, sin(x))\n",
     "end"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2d98e3b8",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Julia 1.9.2",
+   "display_name": "Julia 1.9.3",
    "language": "julia",
    "name": "julia-1.9"
   },

README.md

@@ -6,51 +6,50 @@ The course material is adapted from two sources:
   - the book [ThinkJulia](https://benlauwens.github.io/ThinkJulia.jl/latest/book.html) from Allen Downey and Ben Lauwens ([Creative Commons Attribution-NonCommercial 3.0 Unported license](https://creativecommons.org/licenses/by-nc/3.0/deed.en)).
 
 ## Software and material
-What you need for the workshop (quick overview):
+The course requires various things: a working installation of [Julia 1.9](https://julialang.org/downloads/), [Jupyter](https://jupyter.org/), [IJulia.jl](https://github.com/JuliaLang/IJulia.jl), the course material and various dependencies. To get everything follow these steps:
 
-- [Julia 1.8](https://julialang.org/downloads/)
-- [Jupyter](https://jupyter.org/) and [IJulia.jl](https://github.com/JuliaLang/IJulia.jl)
-- This repository of workshop materials
-- All required dependencies (Julia packages) for the workshop
-
-### Getting Julia
-For following the course you will need at least **Julia 1.8**.
+### 1) Getting Julia
+For following the course you will need **Julia 1.9**.
 Julia can be easily obtained in binary form from [Julia downloads](https://julialang.org/downloads/).
 
-### Getting all the rest
-To get the remaining files and dependencies
-start up `julia` and in the resulting REPL shell,
-copy and paste the following:
+### 2) Getting all the rest
 
+To get the remaining files and dependencies start up `julia` and in the resulting REPL shell, copy and paste the following:
 ```julia
 import Downloads
 script = Downloads.download("https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads")
 include(script)
 ```
-This [downloads the install.jl script](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads)
-and runs it from julia.
-Follow the instructions on the screen and start the Jupyter notebook server
-with the command that will be printed.
+This [downloads the install.jl script](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads) and runs it from julia.
+
+### 2) Getting all the rest (expert version)
 
-As an alternative you can also also run the following commands manually
-(this requires to have `git` and `julia` available from the commandline):
+As an alternative you can also also run the following commands manually (this requires to have `git` and `julia` available from the commandline):
 ```
 git clone https://gitlab.mathematik.uni-stuttgart.de/stammbn/Julia-seminar/
 cd Julia-seminar
 julia install-manual.jl
 ```
 
+### 3) Starting the notebook
+To start the notebook make sure to be in the folder `Julia-seminar` and then run `julia`: an interactive Julia command line will open. In there run this command
+
+```
+using IJulia; notebook(dir=pwd())
+```
+and the notebook will automatically open in a browser.
+
 ### Troubleshooting
 If you are facing issues, check out
 the [great troubleshooting section](https://carstenbauer.github.io/WorkshopWizard.jl/dev/troubleshooting/)
-from the WorkshopWizard package by Carsten Bauer (which `install.jl` is using).
+from the WorkshopWizard package by Carsten Bauer (which is being used by `install.jl`).
 
-### Check everything works
-There is a section in the [00_Installation](00_Installation.ipynb) notebook
-with a few quick commands to check everything works as expected.
-Please run these **before the course**.
+### Troubleshooting
+If you are facing issues, check out
+the [great troubleshooting section](https://carstenbauer.github.io/WorkshopWizard.jl/dev/troubleshooting/)
+from the WorkshopWizard package by Carsten Bauer (which is being used by `install.jl`).
 
-### For Developers: Setting Up `pre-commit`
+## For Developers: Setting Up `pre-commit`
 
 [`pre-commit`](https://pre-commit.com/) is a framework that helps to manage and maintain pre-commit hooks to ensure that your code adheres to a consistent style, prevents errors, and adheres to other quality assurance checks.