Skip to content

Commit

Permalink
Merge pull request #150 from Beramos/installation
Browse files Browse the repository at this point in the history
update installation instructions, fixes #149
  • Loading branch information
Beramos authored Feb 1, 2024
2 parents 0596c7f + b02a4b2 commit b7b2370
Showing 1 changed file with 26 additions and 11 deletions.
37 changes: 26 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,37 @@ There are two ways to download the notebooks.

### Installing Julia

1. Download the *Julia* binaries for your system [here](https://julialang.org/downloads/) we suggest to install the Current Stable Release v1.10.
2. Yes, it is that simple :zap:
There are multiple ways to install julia on your system: install via your package manager, download the binaries, or use the `Juliaup` installation manager.

We recommend the `Juliaup` installation manager.

In the current version of the course we will be using the latest stable release `1.10.0`.

#### using the binaries

1. Go to [this page](https://julialang.org/downloads/#official_binaries_for_manual_download) on the official Julia website and select the binary you want to download given the version and your system specification.
2. Have a look [here](https://julialang.org/downloads/platform/) to see the installation instruction for different platforms.

#### Juliaup

1. Follow the [installation instructions](https://github.com/JuliaLang/juliaup#installation) for your specific platform.
2. Check out the [using Juliaup](https://github.com/JuliaLang/juliaup?tab=readme-ov-file#using-juliaup) details for how to launch Juliaup and execute some commands for your specific system.
3. Install version `1.10.0`: `juliaup add 1.10.0`
4. Make this version the default version: `juliaup default 1.10.0`.

### Starting Julia
For *windows* users, it is as simple as double-clicking the Julia application (after unzipping). For *Linux* users the Julia REPL can be started by executing the binary (after unzipping).
For *windows* users:
- if you are using the binaries: it is as simple as double-clicking the Julia application (after unzipping).
- if you are using `Juliaup`: there is a start menu shortcut and it will show up as a profile in Windows Terminal.

For *Linux* users:
- if you are using the binaries: the Julia REPL can be started by executing the binary (after unzipping), e.g. ```/path/to/julia-1.x.x/bin/julia```. For ease of use, we recommend adding an alias to your dotfiles (.bashrc, .zshrc): ```alias julia=~/julia-1.x.x/bin/julia```
- if you are using `Juliaup`: julia is added to your path and can be started by executing `julia` in a shell.

```bash
/path/to/julia-1.x.x/bin/julia
```
For ease of use, we recommend adding an alias to your dotfiles (.bashrc, .zshrc).
Note that the VS Code extension will also automatically find this Julia installation.

```bash
alias julia=~/julia-1.x.x/bin/julia
```
### Running the notebooks
Open the Julia REPL
Open the Julia REPL using any of the methods described in the previous section.

1. Open the (just) installed Julia application.
2. Install Pluto by copy-pasting the following instruction in the REPL (the terminal that just appeared): `using Pkg; Pkg.add("Pluto")`. This will take two minutes.
Expand Down

0 comments on commit b7b2370

Please sign in to comment.