diff --git a/doc/k4run-args.md b/doc/k4run-args.md index f05454e9..5faf9e64 100644 --- a/doc/k4run-args.md +++ b/doc/k4run-args.md @@ -16,9 +16,12 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and 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: @@ -32,4 +35,15 @@ 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. +The example steering file can then be executed as follows: + +``` +k4run example_steering_file.py --trackingOnly --some-other-args +``` + +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`.