Skip to content

Commit

Permalink
Edit README
Browse files Browse the repository at this point in the history
  • Loading branch information
beomki-yeo committed Nov 10, 2023
1 parent 7bcdb1a commit 7400c1d
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ cmake --build <build_directory> <options>

### Running a partial chain with simplified simulation data

Users can generate muon-like particle simulation data by running following example commands:
Users can generate muon-like particle simulation data with the pre-built detray geometries:

```sh
# Generate telescope geometry data
Expand All @@ -292,6 +292,13 @@ Users can generate muon-like particle simulation data by running following examp

The simulation will also generate the detector json files (geometry, material and surface_grid) in the current directory. It is user's responsibility to move them to an appropriate place (e.g. `<detector_directory>`) and match them to the input file arguments of reconstruction chains.

If users have a geometry json file already, it is also possible to run simulation with `traccc_simulate` application

```sh
# Given that users have a geometry json file
<build_directory>/bin/traccc_simulate --output_directory=<output_directory> --detector_file=detray_json/telescope_detector_geometry.json --material_file=detray_json/telescope_detector_homogeneous_material.json --grid_file=detray_json/telescope_detector_surface_grids.json --event=10 --constraint-step-size-mm=1
```

There are three types of partial reconstruction chain users can operate: `seeding_example`, `truth_finding_example`, and `truth_fitting_example` where their algorithm coverages are shown in the table below. Each of them starts from truth measurements, truth seeds, and truth tracks, respectively.

| Category | Clusterization | Seeding | Track finding | Track fitting |
Expand Down

0 comments on commit 7400c1d

Please sign in to comment.