Commit fb9c2f29 authored by Jonas Schwab's avatar Jonas Schwab
Browse files

Work on help text of command line scripts.

parent 97176d9b
......@@ -19,7 +19,7 @@ from py_alf.utils import bin_count, find_sim_dirs
def _get_arg_parser():
parser = ArgumentParser(
description='Count number of bins in ALF HDF5 file(s), assuming all'
description='Count number of bins in ALF HDF5 file(s), assuming all '
'observables have the same number of bins.',
)
parser.add_argument(
......
......@@ -27,10 +27,10 @@ def _get_arg_parser():
help='Number of bins to remove after first N0 bins.')
parser.add_argument(
'--N0', type=int, default=0,
help='Number of first N0 bins to leave. (default=0)')
help='Number of first N0 bins to keep. (default=0)')
parser.add_argument(
'filename', nargs=1,
help='Name of HDF5 file..')
help='Name of HDF5 file.')
return parser
......
......@@ -58,8 +58,9 @@ def _get_arg_parser():
'needed by py_alf.analysis. (default: None))')
parser.add_argument(
'directories', nargs='*',
help='Directories to analyze. If empty, analyzes all \
directories containing file "data.h5" it can find.')
help='Directories to analyze. If empty, analyzes all '
'directories containing file "data.h5" it can find, '
'starting from the current working directory.')
return parser
......
......@@ -67,25 +67,25 @@ def _get_arg_parser():
"(default: './test_pars.json')")
parser.add_argument(
'--alfdir', default=os.getenv('ALF_DIR', './ALF'),
help="Path to ALF directory. (default: os.getenv('ALF_DIR', './ALF')")
help="Path to ALF directory. (default: os.getenv('ALF_DIR', './ALF'))")
parser.add_argument(
'--branch_R', default="master",
help='Reference branch. (default: master)')
help='Reference branch. (default: master)')
parser.add_argument(
'--branch_T', default="master",
help='Branch to test. (default: master)')
help='Branch to test. (default: master)')
parser.add_argument(
'--machine', default="GNU",
help='Machine configuration (default: "GNU")')
help='Machine configuration. (default: "GNU")')
parser.add_argument(
'--mpi', action='store_true',
help='mpi run (default: False)')
help='Do MPI run(s). (default: False)')
parser.add_argument(
'--n_mpi', default=4,
help='number of mpi processes (default: 4)')
help='Number of MPI processes. (default: 4)')
parser.add_argument(
'--mpiexec', default="mpiexec",
help='Command used for starting a MPI run (default: "mpiexec")')
help='Command used for starting an MPI run. (default: "mpiexec")')
parser.add_argument(
'--mpiexec_args', default='',
help='Additional arguments to MPI executable.')
......
......@@ -42,7 +42,7 @@ def del_bins(filename, N0, N):
filename: str
Name of HDF5 file.
N0: int
Number of first N0 bins to leave.
Number of first N0 bins to keep.
N: int
Number of bins to remove after first N0 bins.
"""
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment