diff --git a/doc/starterkit/k4MarlinWrapperCLIC/Readme.md b/doc/starterkit/k4MarlinWrapperCLIC/Readme.md index 1302d7d3..ea11149c 100644 --- a/doc/starterkit/k4MarlinWrapperCLIC/Readme.md +++ b/doc/starterkit/k4MarlinWrapperCLIC/Readme.md @@ -66,7 +66,7 @@ Marlin clicReconstruction.xml \ --global.MaxRecordNumber=3 ``` -### Reconstruction with with Gaudi through k4MarlinWrapper +### Reconstruction with Gaudi through k4MarlinWrapper We can convert the ``xml`` steering file to a Gaudi steering file (python): @@ -76,34 +76,9 @@ cd CLICPerformance/clicConfig convertMarlinSteeringToGaudi.py clicReconstruction.xml clicReconstruction.py ``` -Reconstruction can be performed with EDM4hep or LCIO input, depending on the output format of the events produced +Reconstruction can be performed with LCIO or EDM4hep input, depending on the output format of the events produced during [Simulation](#simulation). -#### Reconstruction with EDM4hep input - -- When using **EDM4hep** format for the input events to be used in reconstruction, refer to the [**EDM converters**](https://github.com/key4hep/k4MarlinWrapper/blob/master/doc/edmConverters.md) -included with k4MarlinWrapper. Note that: - + *MarlinProcessorWrappers* need input in LCIO format: EDM4hep collections need to be converted to LCIO - + The output collections of *MarlinProcessorWrappers* may be used later by other algorithms: - * Output collections of *MarlinProcessorWrappers* will be in LCIO format unless these are explicitly converted - * Some *MarlinProcessorWrappers* may modify collections instead of producing new ones: the original EDM4hep collection wont be updated in this case and would need conversion from LCIO to EDM4hep. - -- To run *clicReconstruction* with EDM4hep format, use the steering file found in the `test` folder of k4MarlinWrapper: -`test/gaudi_opts/clicRec_e4h_input.py` - + Change line `evtsvc.input = '$TEST_DIR/inputFiles/ttbar1_edm4hep.root'` to point to the location of your input file. - + At the bottom of the file, in the `ApplicationMgr` parameters, change `EvtMax = 3,` to the number of events to run. - - -This can be run with: - -```bash -cd CLICPerformance/clicConfig - -cp ../../../test/gaudi_opts/clicRec_e4h_input.py . - -k4run clicRec_e4h_input.py --EventDataSvc.input ttbar_edm4hep.root -``` - #### Reconstruction with LCIO input - When using **LCIO** format for the input events to be used in reconstruction: @@ -133,3 +108,30 @@ cd CLICPerformance/clicConfig k4run clicReconstruction.py ``` + + +#### Reconstruction with EDM4hep input + +- When using **EDM4hep** format for the input events to be used in reconstruction, refer to the [**EDM converters**](https://github.com/key4hep/k4MarlinWrapper/blob/master/doc/edmConverters.md) +included with k4MarlinWrapper. Note that: + + *MarlinProcessorWrappers* need input in LCIO format: EDM4hep collections need to be converted to LCIO + + The output collections of *MarlinProcessorWrappers* may be used later by other algorithms: + * Output collections of *MarlinProcessorWrappers* will be in LCIO format unless these are explicitly converted + * Some *MarlinProcessorWrappers* may modify collections instead of producing new ones: the original EDM4hep collection wont be updated in this case and would need conversion from LCIO to EDM4hep. + +- To run *clicReconstruction* with EDM4hep format, use the steering file found in the `test` folder of k4MarlinWrapper: +`test/gaudi_opts/clicRec_e4h_input.py` + + Change line `evtsvc.input = '$TEST_DIR/inputFiles/ttbar1_edm4hep.root'` to point to the location of your input file. + + At the bottom of the file, in the `ApplicationMgr` parameters, change `EvtMax = 3,` to the number of events to run. + + +This can be run with: + +```bash +cd CLICPerformance/clicConfig + +cp ../../../test/gaudi_opts/clicRec_e4h_input.py . + +k4run clicRec_e4h_input.py --EventDataSvc.input ttbar_edm4hep.root +``` +