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

Updated readme according to notebook 0.

parent fb8966f2
No related branches found
No related tags found
No related merge requests found
...@@ -8,29 +8,18 @@ The course material is adapted from two sources: ...@@ -8,29 +8,18 @@ The course material is adapted from two sources:
## Software and material ## Software and material
What you need for the workshop (quick overview): What you need for the workshop (quick overview):
- [Julia 1.8](https://julialang.org/downloads/) - [Julia 1.9](https://julialang.org/downloads/)
- [Jupyter](https://jupyter.org/) and [IJulia.jl](https://github.com/JuliaLang/IJulia.jl) - [Jupyter](https://jupyter.org/) and [IJulia.jl](https://github.com/JuliaLang/IJulia.jl)
- This repository of workshop materials - This repository of workshop materials
- All required dependencies (Julia packages) for the workshop - All required dependencies (Julia packages) for the workshop
### Getting Julia ### Getting Julia
For following the course you will need at least **Julia 1.8**. 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 ### Getting all the rest
To get the remaining files and dependencies The easiest way to get the remaining files and dependencies
start up `julia` and in the resulting REPL shell, 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/).
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.
As an alternative you can also also run the following commands manually As an alternative you can also also run the following commands manually
(this requires to have `git` and `julia` available from the commandline): (this requires to have `git` and `julia` available from the commandline):
...@@ -40,15 +29,18 @@ cd Julia-seminar ...@@ -40,15 +29,18 @@ cd Julia-seminar
julia install-manual.jl julia install-manual.jl
``` ```
### 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 ### 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 `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**.
### For Developers: Setting Up `pre-commit` ### For Developers: Setting Up `pre-commit`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment