Skip to content
Snippets Groups Projects
Commit 680ec508 authored by Michele Nottoli's avatar Michele Nottoli
Browse files

Improved clarity.

parent f72f9546
Branches
No related tags found
No related merge requests found
%% Cell type:markdown id:16b28ead tags: %% Cell type:markdown id:16b28ead tags:
# Installation and Setup # Installation and Setup
%% Cell type:markdown id:31ac33c0-18a9-4cfa-8e04-3ee1a0c909eb tags: %% Cell type:markdown id:31ac33c0-18a9-4cfa-8e04-3ee1a0c909eb tags:
# Installation und Einrichtung # Installation und Einrichtung
%% Cell type:markdown id:8829affd tags: %% Cell type:markdown id:8829affd tags:
## Software and material ## Software and material
What you need for the workshop (quick overview, step by step instructions are given later): 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.9](https://julialang.org/downloads/) ### 1) Getting Julia
- [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 **Julia 1.9**. 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/). Julia can be easily obtained in binary form from [Julia downloads](https://julialang.org/downloads/).
### Getting all the rest ### 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: To get the remaining files and dependencies start up `julia` and in the resulting REPL shell, copy and paste the following:
```julia ```julia
import Downloads import Downloads
script = Downloads.download("https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads") script = Downloads.download("https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads")
include(script) 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. 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.
### Getting all the rest (alternative version) ### 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/ git clone https://gitlab.mathematik.uni-stuttgart.de/stammbn/Julia-seminar/
cd Julia-seminar cd Julia-seminar
julia install-manual.jl julia install-manual.jl
``` ```
### Starting the notebook ### 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 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()) using IJulia; notebook(dir=pwd())
``` ```
and the notebook will automatically open in a browser. and the notebook will automatically open in a browser.
### Troubleshooting ### Troubleshooting
If you are facing issues, check out If you are facing issues, check out
the [great troubleshooting section](https://carstenbauer.github.io/WorkshopWizard.jl/dev/troubleshooting/) 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`). from the WorkshopWizard package by Carsten Bauer (which is being used by `install.jl`).
%% Cell type:markdown id:b495d658-ab7a-41fb-819e-0fef02c10772 tags: %% Cell type:markdown id:b495d658-ab7a-41fb-819e-0fef02c10772 tags:
## Software und Material ## Software und Material
Was du für das Seminar benötigst (schneller Überblick, detaillierte Anweisungen werden später gegeben): 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:
- [Julia 1.9](https://julialang.org/downloads/)
- [Jupyter](https://jupyter.org/) und [IJulia.jl](https://github.com/JuliaLang/IJulia.jl)
- Dieses Repository mit den Workshop-Materialien
- Alle benötigten Abhängigkeiten (Julia-Pakete) für das Seminar
### Julia herunterladen ### 1) Julia herunterladen
Um dem Kurs zu folgen, benötigst du **Julia 1.9**. Um dem Kurs zu folgen, benötigst du **Julia 1.9**.
Julia kann leicht in binärer Form von den [Julia-Downloads](https://julialang.org/downloads/) bezogen werden. Julia kann leicht in binärer Form von den [Julia-Downloads](https://julialang.org/downloads/) bezogen werden.
### Alles andere herunterladen ### 2) Alles andere herunterladen
Um die verbleibenden Dateien und Abhängigkeiten zu erhalten, starte `julia` und kopiere im resultierenden REPL-Shell folgenden Code: Um die verbleibenden Dateien und Abhängigkeiten zu erhalten, starte `julia` und kopiere im resultierenden REPL-Shell folgenden Code:
```julia ```julia
import Downloads import Downloads
script = Downloads.download("https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads") script = Downloads.download("https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads")
include(script) include(script)
``` ```
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. 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.
### Den Rest bekommen (alternative Version) ### 2) Den Rest bekommen (Experten-Version)
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): 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):
``` ```
git clone https://gitlab.mathematik.uni-stuttgart.de/stammbn/Julia-seminar/ git clone https://gitlab.mathematik.uni-stuttgart.de/stammbn/Julia-seminar/
cd Julia-seminar cd Julia-seminar
julia install-manual.jl julia install-manual.jl
``` ```
### Starten des Notebooks ### 3) Starten des Notebooks
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: 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:
``` ```
using IJulia; notebook(dir=pwd()) using IJulia; notebook(dir=pwd())
``` ```
und das Notebook wird automatisch im Browser geöffnet. und das Notebook wird automatisch im Browser geöffnet.
### Fehlerbehebung ### Fehlerbehebung
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). 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).
%% Cell type:markdown id:d3d75953 tags: %% Cell type:markdown id:d3d75953 tags:
## Verifying everything works ## Verifying everything works
A few quick commands to run: A few quick commands to run:
%% Cell type:markdown id:e7730114-5064-46d1-b724-e92277ff2f90 tags: %% Cell type:markdown id:e7730114-5064-46d1-b724-e92277ff2f90 tags:
## Überprüfung, ob alles funktioniert ## Überprüfung, ob alles funktioniert
Ein paar schnelle Befehle zum Ausführen: Ein paar schnelle Befehle zum Ausführen:
%% Cell type:code id:7bb04662 tags: %% Cell type:code id:7bb04662 tags:
``` julia ``` julia
using Plots using Plots
p = plot(1, xlim=(0, 3π), ylim=(-1.5, 1.5), title="Sine", marker=2) p = plot(1, xlim=(0, 3π), ylim=(-1.5, 1.5), title="Sine", marker=2)
N = 100 N = 100
@gif for i=1:N @gif for i=1:N
x = (i-1) * 3π / N x = (i-1) * 3π / N
push!(p, x, sin(x)) push!(p, x, sin(x))
end end
``` ```
......
...@@ -6,18 +6,13 @@ The course material is adapted from two sources: ...@@ -6,18 +6,13 @@ 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)). - 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 ## Software and material
What you need for the workshop (quick overview, step by step instructions are given later): 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.9](https://julialang.org/downloads/) ### 1) Getting Julia
- [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 **Julia 1.9**. 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/). Julia can be easily obtained in binary form from [Julia downloads](https://julialang.org/downloads/).
### Getting all the rest ### 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: To get the remaining files and dependencies start up `julia` and in the resulting REPL shell, copy and paste the following:
```julia ```julia
...@@ -27,7 +22,7 @@ include(script) ...@@ -27,7 +22,7 @@ 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. 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.
### Getting all the rest (alternative version) ### 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):
``` ```
...@@ -36,7 +31,7 @@ cd Julia-seminar ...@@ -36,7 +31,7 @@ cd Julia-seminar
julia install-manual.jl julia install-manual.jl
``` ```
### Starting the notebook ### 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 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
``` ```
...@@ -49,6 +44,11 @@ If you are facing issues, check out ...@@ -49,6 +44,11 @@ If you are facing issues, check out
the [great troubleshooting section](https://carstenbauer.github.io/WorkshopWizard.jl/dev/troubleshooting/) 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`). from the WorkshopWizard package by Carsten Bauer (which is being used by `install.jl`).
### 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. [`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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment