Documentation improvements about sntools HOT 5 CLOSED

I’ve updated the examples as discussed, though I decided to use --channel es instead of --ordering normal for the second one: That makes the output shorter and easier to explain because it’s only simulating 4 channel/flavour combinations (instead of 14 for normal mass ordering and all channels).

Also noted explicitly that it’s a command line app.

After those commits, I think #18 covers all the requested documentation improvements and I will merge it soon if there are no additional comments.

from sntools.

@JostMigenda, I like the current example becuase it shows many sntools options. I would keep it along side an improved first run experience.

from sntools.

@benjaminrose Perhaps it’s best to have two separate examples—an introductory one (that’s very quick and uses few optional arguments for clarity), and a more advanced example (that can run for longer and demonstrate many common arguments)?

E.g. sntools fluxes/intp2001.data --format nakazato --endtime 50 as an introduction (that runs in ~15 s on my machine) and sntools fluxes/intp1301.data --format nakazato --ordering normal --distance 20 --detector SuperK --verbose

from sntools.

Regarding compiled version of the LaTeX documentation:
I’ve uploaded a pdf file to release v0.7 and have added an action that should automatically generate a pdf file for every new release and attach it.

from sntools.

Sounds great!

from sntools.