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

Fix typos #227

Merged
merged 2 commits into from
Aug 23, 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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,24 @@ Algorithm to read data from one or multiple input file(s) on disk.
Algorithm to write data to an output file on disk.

## k4run
```bash
```
$ k4run --help
usage: k4run [-h] [--dry-run] [-v] [-n NUM_EVENTS] [-l] [--gdb] [--ncpus NCPUS] [config_files ...]
usage: k4run [--dry-run] [-v] [-n NUM_EVENTS] [-l] [--gdb] [-h] [config_files ...]

Run job in the Key4HEP framework

positional arguments:
config_files Gaudi config (python) files describing the job

options:
-h, --help show this help message and exit
--dry-run Do not actually run the job, just parse the config files
-v, --verbose Run job with verbose output
-n NUM_EVENTS, --num-events NUM_EVENTS
Number of events to run
-l, --list Print all the configurable components available in the framework and exit
-l, --list Print all the configurable components available in the
framework and exit
--gdb Attach gdb debugger
--ncpus NCPUS Start Gaudi in parallel mode using NCPUS processes. 0 => serial mode (default), -1 => use all CPUs
-h, --help show this help message and exit
```
When supplied with a Gaudi steering file `k4run --help file.py` also shows the settable properties of the Gaudi algorithms used in the file. Additionally, it is possible to add further arguments and use them in the steering file by using the Python `argparse.ArgumentParser` shared by `k4run`.
```python
Expand Down
2 changes: 1 addition & 1 deletion k4FWCore/components/EventHeaderCreator.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#include "k4FWCore/DataHandle.h"

/***
* Algortihm that creates an EventHeader collection and fills it with eventNumber and runNumber
* Algorithm that creates an EventHeader collection and fills it with eventNumber and runNumber
*/

namespace edm4hep {
Expand Down
2 changes: 1 addition & 1 deletion k4FWCore/components/PodioOutput.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ StatusCode PodioOutput::finalize() {
// HepMCToEDMConverter.genparticles = "GenParticles";
// Note that quotes are added to all property values,
// which leads to problems with ints, lists, dicts and bools.
// For theses types, the quotes must be removed in postprocessing.
// For these types, the quotes must be removed in postprocessing.
config_stream << std::get<0>(per_property) << " = \"" << std::get<1>(per_property) << "\";" << std::endl;
config_data.push_back(config_stream.str());
}
Expand Down
2 changes: 1 addition & 1 deletion k4FWCore/components/Writer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ class Writer final : public Gaudi::Functional::Consumer<void(const EventContext&
// HepMCToEDMConverter.genparticles = "GenParticles";
// Note that quotes are added to all property values,
// which leads to problems with ints, lists, dicts and bools.
// For theses types, the quotes must be removed in postprocessing.
// For these types, the quotes must be removed in postprocessing.
config_stream << std::get<0>(per_property) << " = \"" << std::get<1>(per_property) << "\";" << std::endl;
config_data.push_back(config_stream.str());
}
Expand Down
2 changes: 1 addition & 1 deletion k4FWCore/include/k4FWCore/DataHandle.h
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ DataHandle<T>::DataHandle(const std::string& descriptor, Gaudi::DataHandle::Mode
}

/**
* Try to retrieve from the transient store. If the retrieval succeded and
* Try to retrieve from the transient store. If the retrieval succeeded and
* this is the first time we retrieve, perform a dynamic cast to the desired
* object. Then finally set the handle as Read.
* If this is not the first time we cast and the cast worked, just use the
Expand Down
4 changes: 2 additions & 2 deletions k4FWCore/include/k4FWCore/MetaDataHandle.h
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ template <typename T> class MetaDataHandle {

/// Set the value for this MetaDataHandle
///
/// @note This can only be called during initalize and/or finalize but not
/// @note This can only be called during initialize and/or finalize but not
/// during execute for algorithms that use it
void put(T);

Expand Down Expand Up @@ -124,7 +124,7 @@ template <typename T> void MetaDataHandle<T>::put(T value) {
throw GaudiException("MetaDataHandle policy violation", "Put for non-writing MetaDataHandle not allowed",
StatusCode::FAILURE);
// check whether we are in the proper State
// put is only allowed in the initalization
// put is only allowed in the initialization

std::string full_descriptor = fullDescriptor();
// DataHandle based algorithms
Expand Down
2 changes: 1 addition & 1 deletion k4Interface/include/k4Interface/ISimG4ActionTool.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class ISimG4ActionTool : virtual public IAlgTool {
/// Retrieve interface ID
DeclareInterfaceID(ISimG4ActionTool, 1, 0);

/** get initilization hook for the user action
/** get initialization hook for the user action
* @return pointer to G4VUserActionInitialization
*/
virtual G4VUserActionInitialization* userActionInitialization() = 0;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class ISimG4DetectorConstruction : virtual public IAlgTool {
/// Retrieve interface ID
DeclareInterfaceID(ISimG4DetectorConstruction, 1, 0);

/** get initilization hook for the geometry
/** get initialization hook for the geometry
* @return pointer to G4VUserDetectorConstruction
*/
virtual G4VUserDetectorConstruction* detectorConstruction() = 0;
Expand Down
2 changes: 1 addition & 1 deletion k4Interface/include/k4Interface/ISimG4EventProviderTool.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class ISimG4EventProviderTool : virtual public IAlgTool {
public:
DeclareInterfaceID(ISimG4EventProviderTool, 1, 0);

/** get initilization hook for the geometry
/** get initialization hook for the geometry
* @return pointer to the G4Event containing primary particles
*/
virtual G4Event* g4Event() = 0;
Expand Down
2 changes: 1 addition & 1 deletion k4Interface/include/k4Interface/ISimG4GflashTool.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
/** @class ISimG4GflashTool SimG4Interface/SimG4Interface/ISimG4GflashTool.h ISimG4GflashTool.h
*
* Interface to the Gflash parametrisation tool.
* It returns the parametriation that should be attached to the GFlashShowerModel.
* It returns the parametrisation that should be attached to the GFlashShowerModel.
*
* @author Anna Zaborowska
*/
Expand Down
2 changes: 1 addition & 1 deletion k4Interface/include/k4Interface/ISimG4ParticleSmearTool.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ class ISimG4ParticleSmearTool : virtual public IAlgTool {
*/
virtual StatusCode smearMomentum(CLHEP::Hep3Vector& aMom, int aPdg = 0) = 0;

/** Check conditions of the smearing model, especially if the given parametrs do not exceed the parameters of the
/** Check conditions of the smearing model, especially if the given parameters do not exceed the parameters of the
* model.
* @param[in] aMinMomentum Minimum momentum.
* @param[in] aMaxMomentum Maximum momentum.
Expand Down
2 changes: 1 addition & 1 deletion k4Interface/include/k4Interface/ISimG4PhysicsList.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class ISimG4PhysicsList : virtual public IAlgTool {
/// Retrieve interface ID
DeclareInterfaceID(ISimG4PhysicsList, 1, 0);

/** get initilization hook for the physics list
/** get initialization hook for the physics list
* @return pointer to G4VModularPhysicsList
*/
virtual G4VModularPhysicsList* physicsList() = 0;
Expand Down
Loading