You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
XIA2tree is a package for sorting XIA list mode data from experiments at the Oslo Cyclotron Laboratory (OCL).
6
6
It reads raw digitizer data, applies detector-specific calibration and time/event building, and produces ROOT histograms and optionally ROOT TTrees for further physics analysis.
7
7
8
-
###What XIA2tree does
8
+
## What XIA2tree does
9
9
At a high level, XIA2tree:
10
10
11
11
- Reads one or more raw XIA list-mode files and interprets the DAQ words.
@@ -16,7 +16,7 @@ At a high level, XIA2tree:
16
16
17
17
For a more detailed description of the internal pipeline and data flow, see [`docs/architecture.md`](docs/architecture.md).
18
18
19
-
###Installing
19
+
##Installing
20
20
The `XIA2tree` project can be downloaded from a custom Homebrew tap. To install follow these steps:
21
21
1) Add the custom repo(tap):
22
22
```bash
@@ -29,7 +29,7 @@ brew install xia2tree
29
29
Note that to install the three first letters are not capitalized, while when running the software from command line you
30
30
need to captialize the first three letters.
31
31
32
-
###Building
32
+
## Building from source
33
33
The `XIA2tree` project has a minimal number of dependencies. You only need `ROOT` and `CMake` installed on your computer.
See `docs/usage.md` for step-by-step usage examples and common workflows.
77
77
78
-
###Command line options
78
+
## Command line options
79
79
80
80
In addition to the minimal example, there are more options:
81
81
@@ -121,7 +121,7 @@ The timing and event-building options are:
121
121
122
122
See [`docs/architecture.md`](docs/architecture.md) for how these parameters affect the internal pipeline.
123
123
124
-
###Configuration and calibration file
124
+
## Configuration and calibration file
125
125
The sorting code requires a calibration/configuration file.
126
126
This file describes the data acquisition system, the number of detectors, which detectors are connected to which DAQ channels, and the calibration of the detectors.
127
127
@@ -132,7 +132,10 @@ Examples of these files are:
132
132
133
133
A more detailed description of the expected YAML structure (including `setup`, `calibration`, `analysis`, and `user_parameters` sections) is available in [`docs/usage.md`](docs/usage.md).
134
134
135
-
### Further documentation
135
+
## License
136
+
See [License](LICENSE).
137
+
138
+
## Further documentation
136
139
137
140
-[`docs/architecture.md`](docs/architecture.md): internal architecture and data flow (pipeline stages, threads, queues, ROOT output).
138
141
-[`docs/usage.md`](docs/usage.md): detailed usage examples, YAML configuration structure, and recommended workflows.
0 commit comments