add instructions on how to reproduce results

README.md

 # Experiments
 
 Repository to collect parameter files and analysis scripts for DG experiments conducted with [`dg1d.jl`](https://git.tpi.uni-jena.de/dg/dg1d.jl).
+
+The following folders contain the parameter files with which the results for my Phd thesis were generated
+- advection_sine
+- burgers_sine
+- eulereq_blast_wave
+- eulereq_sod_shock_tube
+- experiments_grhd_tov
+- grhd_bondi
+- grhd_bondi_infall
+- srhd_simple_wave
+
+## Instructions on how to reproduce results
+
+0. Install Julia
+    - `curl -fsSL https://install.julialang.org | sh`
+    - Install version 1.10
+        - `juliaup add 1.10`
+        - `juliaup default 1.10`
+1. Setup `dg1d.jl`
+    - `git clone git@git.tpi.uni-jena.de:fatteneder/dg1d.jl.git`
+2. Prepare `dg1d.jl` to run the experiments
+    - In theory the latest version should be able to reproduce the results,
+      because `dg1d.jl` employs integration tests to catch regressions in development.
+      However, such tests cannot cover all possiblities, hence, it can easily occur that
+      things do not work.
+      To this end, it is recommened to restore the state of the project as it was used to
+      generate the results.
+    - Restore project state:
+        1. Pick the expirement you want to repeat and navigate to that folder.
+           In that folder you find subfolders, one for each run of the experiment, which
+           contain three files.
+           - A `.toml` file with the parameters.
+           - A `Manifest.toml` file with package versions.
+           - A `dirty` file with the git commit and potential uncommited changes.
+           (In theory, `Manifest.toml` and `dirty` should be the same for all subfolders,
+            because all experiments are typically run at the same time. But just double check
+            in case it forgot to commit something.)
+        2. Restore the git commit.
+            - Go to `dg1d.jl` and `git checkout` the commit listed in the dirty file.
+            - If `dirty` contains uncommited changes, then copy `dirty` to `dg1d.jl`,
+              remove the first two lines with the git commit hash, and run `git apply dirty`.
+              (in general `dirty` should not contain changes, and I haven't really tested
+              the patching yet)
+            - Copy a `Manifest.toml` file over to `dg1d.jl`.
+            - Run
+              ```
+              $ julia --project
+              julia> using Pkg
+              julia> Pkg.instantiate() # should restore versions as used when the experiments were run
+              ```
+3. Run experiments
+```
+$ julia --project
+julia> using dg1d
+julia> main(path_to_parameter_file)
+```