Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixed typos in documentation #163

Merged
merged 2 commits into from
Dec 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<img src="doc/k4marlinwrapper_logo.svg"/>
</p>

k4MarlinWrapper runs [Marlin](https://github.com/iLCSoft/Marlin) procesors as [Gaudi](https://gitlab.cern.ch/gaudi/Gaudi) algorithms.
k4MarlinWrapper runs [Marlin](https://github.com/iLCSoft/Marlin) processors as [Gaudi](https://gitlab.cern.ch/gaudi/Gaudi) algorithms.
It provides the necessary converters and interfaces between the file types and formats used between both frameworks:
- Python interface to configure Marlin processors
- In-memory Event Data Model (EDM) converters between [LCIO](https://github.com/iLCSoft/LCIO) and [EDM4hep](https://github.com/key4hep/EDM4hep)
Expand Down
4 changes: 2 additions & 2 deletions doc/MarlinWrapperIntroduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ convertMarlinSteeringToGaudi.py <input-steering.xml> <output-gaudi-options.py>
### Limitations
This converter script handles almost everything, but there are a few
short-comings which it cannot yet handle:
- Marlin XML steering files can have `include` statments, e.g. `<include
- Marlin XML steering files can have `include` statements, e.g. `<include
ref="Tracking/TrackingDigi.xml"/>`. These cannot be resolved by the converter
script, and it will issue a warning. The easiest way to fix this is to simply
run `Marlin -n` to resolve all these statements and then run the converter
Expand Down Expand Up @@ -190,7 +190,7 @@ give them meaningful names in order to avoid any confusion.
### Configuration options

By default each converter tool will try to convert the complete event content
that is currently availble in the transient event store for the corresponding
that is currently available in the transient event store for the corresponding
source format. **It will skip the conversion of a collection if the same
collection already exists in the other format. This check is done by collection
name.** However, it is possible to control the conversion process with a
Expand Down
10 changes: 5 additions & 5 deletions doc/starterkit/k4MarlinWrapperCLIC/CEDViaWrapper.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ The following steps have been tested with the Key4hep nightly builds release whi
source /cvmfs/sw-nightlies.hsf.org/key4hep/setup.sh
```

To get the CLIC detecor description we clone the `CLICPerformance` repository
To get the CLIC detector description we clone the `CLICPerformance` repository
```bash
git clone https://github.com/iLCSoft/CLICPerformance
```

All the following steps assume that the environment is setup like above and that the detector description is in the `CLICPerformance` directory. All commands start from the diretory from which `git clone` has been executed.
All the following steps assume that the environment is setup like above and that the detector description is in the `CLICPerformance` directory. All commands start from the directory from which `git clone` has been executed.

## Creating an input file

Expand All @@ -51,7 +51,7 @@ ddsim --steeringFile CLICPerformance/clicConfig/clic_steer.py \

You should now have a `gamma_10GeV_edm4hep.root` file containing 10 events.

## Runing the event display
## Running the event display

In order to run the event display via the `DDCEDViewer` we use the Marlin wrapper and attach an EDM4hep to LCIO converter to the wrapped processor. In the following we will build the complete Gaudi options file step by step. Here we simply present the most important steps, but do not go over all details of the `DDCEDViewer` configuration, for that it is probably best to directly look at the [CEDViewer repository](https://github.com/iLCSoft/CEDViewer) directly. The complete Gaudi configuration can be found in [`k4MarlinWrapper/examples/event_display.py`](https://github.com/key4hep/k4MarlinWrapper/blob/master/k4MarlinWrapper/examples/event_display.py) which is also installed at `$K4MARLINWRAPPER/examples/event_display.py`

Expand Down Expand Up @@ -131,8 +131,8 @@ k4run $K4MARLINWRAPPER/examples/event_display.py --EventDataSvc.input=gamma_10Ge

The `event_display.py` options file that is used above and that is present in the examples has been produced following these steps:
- Using an `.slcio` input file and the desired geometry, run `ced2go` with the desired arguments.
- This produces a Marlin xml steering file on the fly and stores it at `/tmp/ced2go_${USER}_steering.xml`
- Using the `convertMarlinSteeringToGaudi.py` converter script convert this into a gaudi options file
- This produces a Marlin XML steering file on the fly and stores it at `/tmp/ced2go_${USER}_steering.xml`
- Using the `convertMarlinSteeringToGaudi.py` converter script convert this into a Gaudi options file
- Exchange the LCIO input reading by the podio input reading (see above)
- Attach the `EDM4hep2LcioTool` to the wrapped `CEDViewer` processor

Expand Down
4 changes: 2 additions & 2 deletions doc/starterkit/k4MarlinWrapperCLIC/howtoMultithread.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Gaudi exposes two main levels of parallelism:
- Inter-event parallelism: running multiple events in parallel
- Intra-event parallelism: running multiple algorithms in parallel, within an event

The two levels of parallelims can be combined: events can run in parallel, and algorithms within the events can run in parallel.
The two levels of parallelism can be combined: events can run in parallel, and algorithms within the events can run in parallel.

### How to run with inter-event parallelism

Expand All @@ -50,7 +50,7 @@ The following components are used to achieve parallelism:
from Configurables import (HiveWhiteBoard, HiveSlimEventLoopMgr, AvalancheSchedulerSvc)
```

These 3 components need to be configued to adapt the level of parallelism to the sequence, algorithms and hardware to be used.
These 3 components need to be configured to adapt the level of parallelism to the sequence, algorithms and hardware to be used.

- Event Data Service: `HiveWhiteBoard`
+ *EventSlots*: Number of events that may run in parallel, each with its own EventStore
Expand Down
Loading