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

Update TBB link in documentation, fix typos #212

Merged
merged 3 commits into from
Dec 12, 2024
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 doc/starterkit/k4MarlinWrapperCLIC/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ 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.
* Some *MarlinProcessorWrappers* may modify collections instead of producing new ones: the original EDM4hep collection won't 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 `examples` folder of k4MarlinWrapper:
`k4MarlinWrapper/examples/clicRec_e4h_input.py` (this also gets installed to `$K4MARLINWRAPPER/examples` in Key4hep releases)
Expand Down
2 changes: 1 addition & 1 deletion doc/starterkit/k4MarlinWrapperCLIC/howtoMultithread.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ limitations under the License.

## Running Gaudi with multithreading support

Gaudi uses [Intel TBB](https://oneapi-src.github.io/oneTBB/) under the hood for multithreading.
Gaudi uses [oneTBB](https://uxlfoundation.github.io/oneTBB/) under the hood for multithreading.

Gaudi exposes two main levels of parallelism:
- Inter-event parallelism: running multiple events in parallel
Expand Down
4 changes: 2 additions & 2 deletions k4MarlinWrapper/scripts/convertMarlinSteeringToGaudi.py
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ def verbosityTranslator(marlinLogLevel):


def convertParameters(params, proc, globParams, constants):
"""convert json of parameters to gaudi"""
"""convert json of parameters to Gaudi"""
lines = []
if "Verbosity" in params:
lines.append(
Expand Down Expand Up @@ -259,7 +259,7 @@ def convertProcessors(lines, tree, globParams, constants):


def findWarnIncludes(tree):
"""Check the parsed XML structure for include statments and issue a warning"""
"""Check the parsed XML structure for include statements and issue a warning"""
if any(True for _ in tree.iter("include")):
print(
'ERROR: Found at least one <include ref="..."/> statement in the Marlin steering file'
Expand Down
7 changes: 3 additions & 4 deletions k4MarlinWrapper/src/components/EDM4hep2Lcio.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ podio::CollectionBase* EDM4hep2LcioTool::getEDM4hepCollection(const std::string&
throw GaudiException("Collection could not be casted to the expected type", name(), StatusCode::FAILURE);
}

// Select the appropiate method to convert a collection given its type
// Select the appropriate method to convert a collection given its type
void EDM4hep2LcioTool::convertAdd(const std::string& e4h_coll_name, const std::string& lcio_coll_name,
lcio::LCEventImpl* lcio_event, CollectionPairMappings& collection_pairs,
std::vector<EDM4hep2LCIOConv::ParticleIDConvData>& pidCollections,
Expand Down Expand Up @@ -412,8 +412,7 @@ StatusCode EDM4hep2LcioTool::convertCollections(lcio::LCEventImpl* lcio_event) {

EDM4hep2LCIOConv::attachDqdxInfo(collection_pairs.tracks, dQdxCollections);

// We want one "global" map that is created the first time it is use in the
// event.
// We want one "global" map that is created the first time it is used in the event.
DataObject* obj = nullptr;
auto sc = evtSvc()->retrieveObject(GlobalConvertedObjectsMap::TESpath.data(), obj);
if (sc.isFailure()) {
Expand All @@ -434,7 +433,7 @@ StatusCode EDM4hep2LcioTool::convertCollections(lcio::LCEventImpl* lcio_event) {

EDM4hep2LCIOConv::resolveRelations(collection_pairs, globalObjMap);

// Now we can convert the assocations and add them to the event
// Now we can convert the links and add them to the event
for (auto& [name, coll] : EDM4hep2LCIOConv::createLCRelationCollections(linkCollections, globalObjMap)) {
lcio_event->addCollection(coll.release(), name);
}
Expand Down
3 changes: 1 addition & 2 deletions k4MarlinWrapper/src/components/Lcio2EDM4hep.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -213,8 +213,7 @@ StatusCode Lcio2EDM4hepTool::convertCollections(lcio::LCEventImpl* the_event) {
edm4hep::utils::PIDHandler::setAlgoInfo(metadataFrame, collName, pidInfo);
}

// We want one "global" map that is created the first time it is use in the
// event.
// We want one "global" map that is created the first time it is used in the event.
DataObject* obj = nullptr;
auto sc = evtSvc()->retrieveObject(GlobalConvertedObjectsMap::TESpath.data(), obj);
if (sc.isFailure()) {
Expand Down
2 changes: 1 addition & 1 deletion k4MarlinWrapper/src/components/LcioEventOutput.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ void LcioEventOutput::dropCollections(lcio::LCEventImpl* event, std::vector<lcio
}
}

// don't store hit pointers if hits are droped
// don't store hit pointers if hits are dropped
if (evt_coll_type == lcio::LCIO::TRACK && th_drop) {
std::bitset<32> flag(evt_coll->getFlag());
flag[lcio::LCIO::TRBIT_HITS] = 0;
Expand Down
2 changes: 1 addition & 1 deletion k4MarlinWrapper/src/components/MarlinProcessorWrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ StatusCode MarlinProcessorWrapper::instantiateProcessor(std::shared_ptr<marlin::
}

StatusCode MarlinProcessorWrapper::initialize() {
// initalize global marlin information, maybe betters as a _tool_
// initialize global marlin information, maybe betters as a _tool_
static bool once = true;
if (once) {
once = false;
Expand Down
2 changes: 1 addition & 1 deletion test/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ ExternalData_Add_Test( marlinwrapper_tests NAME clicRec_lcio_mt COMMAND bash -c
# Test the GeoSvc and TrackingCellIDEncodingSvc
add_test( clic_geo_test ${K4RUN} ${CMAKE_CURRENT_SOURCE_DIR}/gaudi_opts/geoTest_cld.py )

# Test for checking whether the converters can resolve relations accross
# Test for checking whether the converters can resolve relations across
# multiple processors
ExternalData_Add_Test( marlinwrapper_tests NAME global_converter_maps COMMAND ${K4RUN} ${CMAKE_CURRENT_SOURCE_DIR}/gaudi_opts/test_global_converter_maps.py --EventDataSvc.input DATA{${PROJECT_SOURCE_DIR}/test/input_files/ttbar_20240223_edm4hep.root})

Expand Down
4 changes: 2 additions & 2 deletions test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

The test cases for the k4MarlinWrapper are somewhat involved in some cases.
Hence, we try to describe their intent and their high level layout a bit here.
We will be refering to the test cases by name as they are defined in the
We will be referring to the test cases by name as they are defined in the
[`CMakeLists.txt`](./CMakeLists.txt) file in here.

## `global_converter_maps`
Expand All @@ -39,7 +39,7 @@ effectively simply runs the
[`test_global_converter_maps.py`](./gaudi_opts/test_global_converter_maps.py)
options file after downloading some input data. This options file uses one
wrapped MarlinProcessor, one GaudiAlgorithm and one Gaudi Functional algorithm
plus some converters inbetween them:
plus some converters in-between them:
- `PodioInput` to read the *MCParticles* collection from the input file (in
EDM4hep format)
- [`PseudoRecoAlgorithm`](./src/PseudoRecoAlgorithm.cc) creates a reco particle
Expand Down
Loading