Skip to content
Snippets Groups Projects

update readme

Merged YingXing requested to merge fix-multiple-julia-issue into main
1 file
+ 35
4
Compare changes
  • Side-by-side
  • Inline
+ 69
10
@@ -33,13 +33,44 @@ cd Julia-seminar
julia install-manual.jl
```
### 3) Starten des Notebooks
Um das Notebook zu starten, stelle sicher, dass Du Dich im Ordner `Julia-seminar` befindest, und führe dann `julia` aus: Eine interaktive Julia-Befehlszeile wird geöffnet. Führe darin folgenden Befehl aus:
### 3) Das Notebook starten
#### Aus der Julia REPL
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 den folgenden Befehl aus:
```julia
using Pkg
Pkg.activate(pwd())
using IJulia
notebook(dir=pwd())
```
using IJulia; notebook(dir=pwd())
und das Notebook wird automatisch in einem Browser geöffnet.
Navigieren Sie zu den Dateien und öffnen Sie das Notebook Nummer 0.
#### Über die Befehlszeile
Alternativ kann man das Notebook auch über die Befehlszeile öffnen:
```bash
julia -L start-notebook.jl
```
und das Notebook wird automatisch im Browser geöffnet.
### \* Für Benutzer mit mehreren Julia-Versionen
Für Benutzer mit mehreren Julia-Versionen, falls der entsprechende Kernel in Jupyter Notebook nicht gefunden werden kann, führen Sie bitte `installkernel("julia", "--project=@.")` (nur einmal) aus, bevor Sie `notebook(dir=pwd())` ausführen, um zuerst den Kernel zu installieren:
```julia
using Pkg
Pkg.activate(pwd())
using IJulia
installkernel("julia", "--project=@.")
notebook(dir=pwd())
```
Nun sollte man in Jupyter Notebook einen neuen Kernel finden, der mit der aktuellen Julia-Version verknüpft ist und den Namen `julia "Julia-Version"` trägt.
### Fehlerbehebung
Wenn Du auf Probleme stößt, werfe 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).
@@ -80,21 +111,49 @@ julia install-manual.jl
```
### 3) Starting the notebook
#### From Julia REPL
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
```julia
using Pkg
Pkg.activate(pwd())
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.
Navigate the files and open notebook number 0.
#### From command line
Alternatively, one can open the notebook from the command line:
```bash
julia -L start-notebook.jl
```
### \* For users with multiple Julia versions
For users with multiple Julia versions, if the corresponding kernel cannot be found in Jupyter Notebook, please run `installkernel("julia", "--project=@.")` (only once) before executing `notebook(dir=pwd())` to first install the kernel:
```julia
using Pkg
Pkg.activate(pwd())
using IJulia
installkernel("julia", "--project=@.")
notebook(dir=pwd())
```
Now, one should find a new kernel related to the current Julia version, named `julia "Julia-version"`, in Jupyter Notebook.
### 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.
@@ -107,14 +166,14 @@ from the WorkshopWizard package by Carsten Bauer (which is being used by `instal
For more information and installation options, visit the [`pre-commit`](https://pre-commit.com/) website.
2. **Navigate to the Project Directory:**
2. **Navigate to the project directory:**
Change into the project directory, i.e., `julia-seminar` by running:
```bash
cd julia-seminar
```
3. **Install Hooks:**
3. **Install hooks:**
Install the git hooks by executing:
```bash
Loading