Skip to content

Commit

Permalink
Added windows instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
peremato committed Apr 24, 2024
1 parent 9224122 commit c2d851e
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Geant4.jl-tutorial
`# Geant4.jl-tutorial
Materials for the Geant4.jl Tutorial.

Read the rendered Jupyter book: https://peremato.github.io/Geant4.jl-tutorial/index.html
Expand All @@ -7,7 +7,8 @@ Read the rendered Jupyter book: https://peremato.github.io/Geant4.jl-tutorial/in
[![Binder](https://binderhub.ssl-hep.org/badge_logo.svg)](https://binderhub.ssl-hep.org/v2/gh/peremato/Geant4.jl-tutorial/HEAD?labpath=tutorial%2Fdocs%2F01-introduction.ipynb)

## Follow the tutorial on a local computer:
To install all what is needed:
You need to install julia and jupyter in your system. These are the instructions:
### Linux or MacOS
```bash
# install Julia
curl -fsSL https://install.julialang.org | sh
Expand All @@ -23,9 +24,27 @@ julia -e 'using IJulia; installkernel("Julia")'
julia -e 'using IJulia; jupyterlab(dir="tutorial/docs")'
```

### Windows
```cmd
REM install Julia from Microsoft Store
winget install julia -s msstore
REM or using the Windows Julia installed from https://julialang.org/downloads/
REM make sure that julia is added to the PATH
REM clone the tutorial repository
git clone https://github.com/peremato/Geant4.jl-tutorial.git
cd Geant4.jl-tutorial
REM instantiate this project and install jupyter
set JULIA_PROJECT=@.
julia -e "using Pkg;Pkg.instantiate()"
julia -e "using IJulia; installkernel(\"Julia\")"
julia -e "using IJulia; jupyterlab(dir=\"tutorial/docs\")"
```
- - -
When not taken from other sources (with its own Copyright and License), this material is:

Copyright © 2023 CERN and the authors / contributors.

Licensed under [CC-BY-4.0](./LICENSE).
Licensed under [CC-BY-4.0](./LICENSE).`

0 comments on commit c2d851e

Please sign in to comment.