Skip to content

Commit

Permalink
Update git clone details in Ep.1
Browse files Browse the repository at this point in the history
  • Loading branch information
zsweger authored Sep 11, 2024
1 parent 3a65a1f commit 0217503
Showing 1 changed file with 55 additions and 1 deletion.
56 changes: 55 additions & 1 deletion _episodes/01-first_benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,14 @@ Benchmarks are currently organized into two repositories:
Let's make a detector benchmark. We start by cloning the git repository

```bash
git clone git@github.com:eic/detector_benchmarks.git
git clone https://github.com/eic/detector_benchmarks.git
cd detector_benchmarks
```
or
```bash
git clone https://github.com/eic/physics_benchmarks.git
cd physics_benchmarks
```

(If you get an error here, you might need to set up your SSH keys.)

Expand Down Expand Up @@ -50,6 +55,7 @@ mkdir benchmarks/backwards_ecal

The Continuous Integration system needs to know what steps it has to execute. This is specified using YAML files. Create a file `benchmarks/backwards_ecal/config.yml` with the following contents:

For a detector benchmark:
~~~
sim:ecal_backwards_electron:
extends: .det_benchmark
Expand All @@ -75,6 +81,54 @@ bench:ecal_backwards_resolution:
~~~
{: .language-yaml }

For a physics benchmark:
~~~
your_benchmark:compile:
extends: .phy_benchmark
stage: compile
script:
- echo "You can compile your code here!"
your_benchmark:generate:
extends: .phy_benchmark
stage: generate
script:
- echo "I will generate events here!"
- echo "Add event-generator code to do this"
your_benchmark:simulate:
extends: .phy_benchmark
stage: simulate
script:
- echo "I will simulate detector response here!"
your_benchmark:reconstruct:
extends: .phy_benchmark
stage: reconstruct
script:
- echo "Event reconstruction here!"
your_benchmark:analyze:
extends: .phy_benchmark
stage: analyze
needs:
- ["your_benchmark:reconstruct"]
script:
- echo "I will analyze events here!"
- echo "This step requires that the reconstruct step be completed"
your_benchmark:collect
extends: .phy_benchmark
stage: collect
needs:
- ["your_benchmark:analyze"]
script:
- echo "I will collect results here!"
- echo "This step requires that the analyze step be completed"
~~~
{: .language-yaml }

The basic idea here is that we define three jobs to be run in two steps. The reason for the separation is to allow parallel execution and for them to be presented nicely in the user interface.

Since we've just created a new file, we need to let git know about it by staging it:
Expand Down

0 comments on commit 0217503

Please sign in to comment.