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.

Sign up for GitHub

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

Improve the documentation about extending the parser for k4run #269

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve the documentation about extending the parser for k4run #269

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 8 additions & 2 deletions doc/k4run-args.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ limitations under the License.
-->
# Adding custom arguments to `k4run`

It is possible to extend `k4run` with custom arguments from a steering file using `k4FWCore.parseArgs`.
It is possible to extend `k4run` with custom arguments from a steering file
using `k4FWCore.parseArgs`.

Example:

Expand All @@ -32,4 +33,9 @@ if my_opts.trackingOnly:
# only run track reconstruction
```

Behind the scenes parser is just a normal instance of pythons [`argparse.ArgumentParser`](https://docs.python.org/3/library/argparse.html), please refer to its documentation for usage details. The only important thing to keep in mind is to always use `parse_known_args()` instead of `parse_args()` so that the normal `k4run` arguments keep working.
Behind the scenes `parser` is just a normal instance of python's
[`argparse.ArgumentParser`](https://docs.python.org/3/library/argparse.html),
please refer to its documentation for usage details. Use `parse_known_args()`
instead of `parse_args()` so that the normal `k4run` arguments keep working. The
`[0]` is necessary because the added arguments will be in the first element of
the tuple returned from `parse_known_args`.
Loading