dirac-institute / sorcha

An open-source community LSST Solar System Simulator
Other
18 stars 18 forks source link

sorcha-run without any parameters does not give intuitive suggestions #1019

Open fedorets opened 2 months ago

fedorets commented 2 months ago

When running 'sorcha-run' the command-line suggestions are not intuitive.

It was mutually agreed that in this case, the output of 'sorcha-run -h' is desired.

978 is a related issue.

mschwamb commented 2 months ago

That's not quite what was agreed for in the call. We agreed that we can add a bit more detail on the usage line and an error message that reminds the user to use sorcha-run --help if they want a full refresher

mjuric commented 2 weeks ago

Hmm, what's the error message it outputs w/o the #1061 patch?

argparse should give the usual "short" summary of the command line options by default.

mschwamb commented 2 weeks ago

usage: sorcha-run [-h] -c C -o O -ob OB -p P -pd PD [-er ER] [-ew EW] [-ar AR] [-cp CP] [-f] [-s S] [-t T] [-v] [-st ST] sorcha-run: error: the following arguments are required: -c/--config, -o/--outfile, -ob/--orbit, -p/--params, -pd/--pointing_database Error: Command 'sorcha-run' failed with exit code 2.

mschwamb commented 2 weeks ago

The beta tester thought it was not intuitive to know how to get help to know what all those things were

mschwamb commented 2 weeks ago

So I'm adding this only if you provide no command line arguments to sorcha run

`

Error: No command line arguments provided!!! Use the -h flag to see descriptions of the required and optional arguments needed to run Sorcha

`

mjuric commented 2 weeks ago

Astronomers always need to be special 🙄...

image
mjuric commented 2 weeks ago

I'll comment on the PR, I'd propose one small tweak.