Commit 93b53032 authored by erwan's avatar erwan
Browse files

More aesthetic enhancements in the README + fix the page job again

parent fbcef473
Pipeline #40129 failed with stages
in 5 minutes and 2 seconds
......@@ -15,10 +15,10 @@ expe-sasa.4.0.3:
script:
- opam depext -y ocamlgraph.1.8.8 camlidl.1.07 mlgmpidl.1.2.12 lutils.1.50.0 rdbg.1.188.4 lustre-v6.6.101.17 lutin.2.71.1 sasa.4.0.3
- opam install -y ocamlgraph.1.8.8 camlidl.1.07 mlgmpidl.1.2.12 lutils.1.50.0 rdbg.1.188.4 lustre-v6.6.101.17 lutin.2.71.1 sasa.4.0.3
- make
- make
artifacts:
paths:
- result
- expe/result
# The same experiment using the lastest opam versions
expe-current:
......@@ -30,7 +30,7 @@ expe-current:
- make
artifacts:
paths:
- result
- expe/result
# Ditto using the verimag-sync-tools image where everything is already
# installed
......@@ -43,7 +43,7 @@ expe-dockver:
- make
artifacts:
paths:
- result
- expe/result
pages:
stage: deploy
......@@ -52,7 +52,7 @@ pages:
- apt-get install tree
script:
- mkdir .public
- cp -rf result .public/
- cp -rf expe/result .public/
- tree -h -H '.' -L 2 --noreport --charset utf-8 --prune > index.html
- cd ..
- mv .public public
......
......@@ -3,6 +3,8 @@
all:
cd expe ; make && make save_result
bigexpe:
cd expe ; make && make bigexpe && make save_result
git:
git commit -a -F log
......
- [Artifact of the article **SASA: a SimulAtor of Self-stabilizing Algorithms** published in TAP 2020](#orgc6f1dd8)
- [Using The TAP Virtual Machine](#org7d99bf4)
- [Using Docker](#orgc0e654b)
- [Instructions to generate the data contained in Fig.1 of Section 2](#orga6ee562)
- [Instructions to generate the data contained in Table 1 of Section 4](#org4984bb8)
- [Artifact of the article **SASA: a SimulAtor of Self-stabilizing Algorithms** published in TAP 2020](#orgceb28a4)
- [Using The TAP Virtual Machine](#org3e152d4)
- [Using Docker](#orgb853e47)
- [Instructions to generate the data contained in Fig.1 of Section 2](#orgb5fbc60)
- [Instructions to generate the data contained in Table 1 of Section 4](#orgaf53d00)
<a id="orgc6f1dd8"></a>
<a id="orgceb28a4"></a>
# Artifact of the article **SASA: a SimulAtor of Self-stabilizing Algorithms** published in TAP 2020
......@@ -24,7 +24,7 @@ By following the instructions, you should be able to replay the experiments, but
- <https://verimag.gricad-pages.univ-grenoble-alpes.fr/synchrone/sasa/>
<a id="org7d99bf4"></a>
<a id="org3e152d4"></a>
## Using The TAP Virtual Machine
......@@ -35,14 +35,14 @@ They should be executed under a VM that you should find here: <https://struebli.
cf <https://tap.sosy-lab.org/2020/callforartifacts.php>
<a id="orgc0e654b"></a>
<a id="orgb853e47"></a>
## Using Docker
You can mimic one the CI job defined in [.gitlab-ci.yml](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/reproducible-research/sasartifact/blob/master/.gitlab-ci.yml). For instance, if you want to do as in the `expe-dockver` job, you just need to run docker using the `jahierwan/verimag-sync-tools` image (which is available in the cloud) as follows:
```sh
https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/reproducible-research/sasartifact.git
git clone https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/reproducible-research/sasartifact.git
cd expe
docker run --user `id -u` \
-v "$PWD":/current_dir -w /current_dir \
......@@ -59,7 +59,7 @@ If the last command has run without problem, you are inside a docker image where
You can thus proceed with the instructions below.
<a id="orga6ee562"></a>
<a id="orgb5fbc60"></a>
### Instructions to generate the data contained in Fig.1 of Section 2
......@@ -72,23 +72,23 @@ cd async-unison
make rdbg4
```
You ought to be prompted to type <Enter> or "q" and then <Enter>. Choose the first proposal and press the <Enter> key; this creates a default session using commands defined in the Makefile by the rdbg4 rule.
You ought to be prompted to type `<Enter>` or `q` and then `<Enter>` Choose the first proposal and press the `<Enter>` key; this creates a default session using commands defined in [expe/async-unison/Makefile](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/reproducible-research/sasartifact/blob/master/expe/async-unison/Makefile) by the `rdbg4` rule.
You ought to see:
1. A pdf view of 4x4 grid with enabled nodes in green, and active ones in orange. This pdf corresponds to the configuration 1 of Fig1 in the article. The active nodes (among the enabled ones) are not necessarily the same as in the article as we did not set the seed of the pseudo-random generator.
2. the (rdbg) prompt in your terminal
2. the `(rdbg)` prompt in your terminal
At the (rdbg) prompt, type "sd" and <Enter>. This will make the simulation move 1 step forward, and update automatically the pdf view that shows up something equivalent to Configuration 2 in Fig1.
At the `(rdbg)` prompt, type `sd` and `<Enter>`. This will make the simulation move 1 step forward, and update automatically the pdf view that shows up something equivalent to Configuration 2 in Fig1.
At the (rdbg) prompt, type <Enter> to replay the last command (i.e., "sd"), and hence move to Configuration 3.
At the `(rdbg)` prompt, type `<Enter>` to replay the last command (i.e., `sd`), and hence move to Configuration 3.
Type <Enter> 3 more times to see Configurations 4, 5, and 6 of Fig.1.
Type `<Enter>` 3 more times to see Configurations 4, 5, and 6 of Fig.1.
Type "q" to exit.
Type `q` to exit.
<a id="org4984bb8"></a>
<a id="orgaf53d00"></a>
### Instructions to generate the data contained in Table 1 of Section 4
......@@ -98,7 +98,7 @@ In order to run the experiments described in Section 4, type in a terminal, from
make expe
```
It launches the experiments on 2 small graphs (grid.dot and ER.dot). It should last a few minutes. Once the previous command returns, you can launch:
It launches the experiments on 2 small graphs (`grid.dot` and `ER.dot`). It should last a few minutes. Once the previous command returns, you can launch:
```sh
find . -name \*.log
......@@ -110,7 +110,7 @@ to see the generated log files. Those files contain the memory usage and the exe
make save_result
```
a (sed) script will parse those .log files to generate a "summary.org" file and save generated files in a directory named "result". The summary.org file ought to contain a summary of all the experiments you have just performed. Table 1 was obtained out of it.
a (sed) script will parse those .log files to generate a `summary.org` file and save generated files in a directory named `result`. The summary.org file ought to contain a summary of all the experiments you have just performed. Table 1 was obtained out of it.
The correspondence between directory names and the Column 1 names is
......@@ -130,7 +130,7 @@ make bigexpe
make save_result
```
Some remarks, comparing the results announced in the paper and the ones obtained in the VM:
Some remarks, comparing the results announced in the paper and the ones obtained on your machine:
- The number of seconds (time/step) may differ as the table was obtained using an other machine.
- 2 examples may run out of memory on your machine: the dfs algo on `hugeER.dot` and `biggrid.dot`. Indeed, as one can notice in Table 1, those examples require more memory (6.6 and 29 G) than your machine have.
......@@ -36,7 +36,7 @@ docker using the =jahierwan/verimag-sync-tools= image (which is
available in the cloud) as follows:
#+BEGIN_SRC sh
https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/reproducible-research/sasartifact.git
git clone https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/reproducible-research/sasartifact.git
cd expe
docker run --user `id -u` \
-v "$PWD":/current_dir -w /current_dir \
......@@ -66,10 +66,10 @@ cd async-unison
make rdbg4
#+END_SRC
You ought to be prompted to type <Enter> or "q" and then <Enter>.
Choose the first proposal and press the <Enter> key; this creates a
default session using commands defined in the Makefile by the rdbg4
rule.
You ought to be prompted to type =<Enter>= or =q= and then =<Enter>=
Choose the first proposal and press the =<Enter>= key; this creates a
default session using commands defined in
{{{git(expe/async-unison/Makefile)}}} by the =rdbg4= rule.
You ought to see:
1. A pdf view of 4x4 grid with enabled nodes in green, and active ones
......@@ -77,18 +77,18 @@ You ought to see:
the article. The active nodes (among the enabled ones) are not
necessarily the same as in the article as we did not set the seed
of the pseudo-random generator.
2. the (rdbg) prompt in your terminal
2. the =(rdbg)= prompt in your terminal
At the (rdbg) prompt, type "sd" and <Enter>. This will make the
At the =(rdbg)= prompt, type =sd= and =<Enter>=. This will make the
simulation move 1 step forward, and update automatically the pdf view
that shows up something equivalent to Configuration 2 in Fig1.
At the (rdbg) prompt, type <Enter> to replay the last command
(i.e., "sd"), and hence move to Configuration 3.
At the =(rdbg)= prompt, type =<Enter>= to replay the last command
(i.e., =sd=), and hence move to Configuration 3.
Type <Enter> 3 more times to see Configurations 4, 5, and 6 of Fig.1.
Type =<Enter>= 3 more times to see Configurations 4, 5, and 6 of Fig.1.
Type "q" to exit.
Type =q= to exit.
*** Instructions to generate the data contained in Table 1 of Section 4
......@@ -99,8 +99,8 @@ terminal, from the {{{git(expe)}}} directory:
make expe
#+END_SRC
It launches the experiments on 2 small graphs (grid.dot and
ER.dot). It should last a few minutes. Once the previous command
It launches the experiments on 2 small graphs (=grid.dot= and
=ER.dot=). It should last a few minutes. Once the previous command
returns, you can launch:
#+BEGIN_SRC sh
......@@ -114,8 +114,8 @@ and the execution time of each individual experiment. If you launch:
make save_result
#+END_SRC
a (sed) script will parse those .log files to generate a "summary.org"
file and save generated files in a directory named "result". The
a (sed) script will parse those .log files to generate a =summary.org=
file and save generated files in a directory named =result=. The
summary.org file ought to contain a summary of all the experiments you
have just performed. Table 1 was obtained out of it.
......@@ -130,8 +130,8 @@ The correspondence between directory names and the Column 1 names is
The corresponding algorithms are encoded in file p.ml of each directory.
If you want to generate the experiment results for the 2 bigger graphs
(=biggrid.dot= and =bigER.dot=), you need to be more patient (a few hours)
and to launch:
(=biggrid.dot= and =bigER.dot=), you need to be more patient (a few
hours) and to launch:
#+BEGIN_SRC sh
make bigexpe
......@@ -139,7 +139,7 @@ make save_result
#+END_SRC
Some remarks, comparing the results announced in the paper and the ones
obtained in the VM:
obtained on your machine:
- The number of seconds (time/step) may differ as the table was
obtained using an other machine.
- 2 examples may run out of memory on your machine: the dfs algo on =hugeER.dot=
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment