From d5965102f3fc7e417af765bee49924f2e5557346 Mon Sep 17 00:00:00 2001 From: Abhimanyu Susobhanan Date: Wed, 18 Dec 2024 15:35:22 +0100 Subject: [PATCH] description --- docs/src/pyvela.md | 2 ++ pyvela/pyvela/pyvela_script.py | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/src/pyvela.md b/docs/src/pyvela.md index 969fd2cc..3dc42083 100644 --- a/docs/src/pyvela.md +++ b/docs/src/pyvela.md @@ -178,6 +178,8 @@ syntax. ``` $ pyvela -h +A command line interface for the Vela.jl pulsar timing & noise analysis package + usage: pyvela [-h] [-P PRIOR_FILE] [--cheat_prior_scale CHEAT_PRIOR_SCALE] [-o OUTDIR] [-N NSTEPS] [-b BURNIN] [-t THIN] par_file tim_file positional arguments: diff --git a/pyvela/pyvela/pyvela_script.py b/pyvela/pyvela/pyvela_script.py index fc401bb4..8e2a1f69 100644 --- a/pyvela/pyvela/pyvela_script.py +++ b/pyvela/pyvela/pyvela_script.py @@ -45,7 +45,10 @@ def info_dict(args): def parse_args(argv): - parser = ArgumentParser() + parser = ArgumentParser( + prog="pyvela", + description="A command line interface for the Vela.jl pulsar timing & noise analysis package", + ) parser.add_argument("par_file") parser.add_argument("tim_file") parser.add_argument("-P", "--prior_file")