Skip to content

Commit 1f0963b

Browse files
Merge pull request #14 from aai-institute/fariedabuzaid-patch-1
Update installation instructions
2 parents 0d2f76f + 6316b69 commit 1f0963b

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

README.md

+13-19
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,27 @@ Welcome to the TransferLab training: Probabilistic Model Checking with Storm.
44
The content was created by two major researchers in the field, Prof. [Joost-Pieter Katoen](https://moves.rwth-aachen.de/people/katoen/) and Assoc. Prof. [Sebastian Junges](https://sjunges.github.io). The course contains a mix of lectures and hands-on exercises covering
55
the fundamentals of probabilistic model checking as well as practical applications using the model checker Storm.
66

7+
## Getting started
78

8-
## During the training
9+
If you want to execute the notebooks, we recommend to use docker. You can
10+
eigther download a pre-build image from ghcr or build the image locally.
911

10-
If you are currently participating in the training, you can find the agenda in
11-
the file `AGENDA.md`. Everything is already set up, so feel free to follow the
12-
trainer's presentation or to explore the notebooks and source code on your own.
12+
1. Option a) Pull the pre-build image from [ghcr.io](ghcr.io/aai-institute/tfl-training-probabilistic-model-checking:main)
13+
```shell
14+
docker pull ghcr.io/aai-institute/tfl-training-probabilistic-model-checking:main
15+
```
16+
Option b) Build the image with
1317

14-
## After the training
15-
16-
You have received this file as part of the training materials.
17-
18-
There are multiple ways of viewing/executing the content.
19-
20-
1. If you just want to view the rendered notebooks, open `html/index.html` in
21-
your browser.
22-
2. If you want to execute the notebooks, we recommend to use docker. You can
23-
build the image locally. First, set the variable
24-
`PARTICIPANT_BUCKET_READ_SECRET` to the secret found in `config.yml`, and then
25-
build the image with
2618
```shell
27-
docker build --build-arg PARTICIPANT_BUCKET_READ_SECRET=$PARTICIPANT_BUCKET_READ_SECRET -t tfl-training-probabilistic-model-checking .
19+
docker build --build-arg -t tfl-training-probabilistic-model-checking .
2820
```
29-
You can then start the container e.g., with
21+
22+
2. You can then start the container e.g., with
3023
```shell
3124
docker run -it -p 8888:8888 tfl-training-probabilistic-model-checking jupyter notebook
3225
```
33-
4. The data will be downloaded on the fly when you run the notebooks.
26+
3. Run the first notebook **welcome_run_me_first.ipynb** within jupyter. This will dowload the data for
27+
the workshop and finilize the setup.
3428

3529
Note that there is some non-trivial logic in the entrypoint that may collide
3630
with mounting volumes to paths directly inside

0 commit comments

Comments
 (0)