description

abhisrkckl · Dec 18, 2024 · d596510 · d596510
1 parent 9813a57
commit d596510
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git 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
@@ -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")