Improved first-run experience

SNEWS2 / sntools

Event generator for supernova burst neutrinos

BSD 3-Clause "New" or "Revised" License

11 stars 11 forks source link

Improved first-run experience #20

Closed JostMigenda closed 3 years ago

JostMigenda commented 3 years ago

Inspired by this comment by @bradkav in the JOSS review. This adds an sntools.setup() function that users should run immediately after installing sntools. It downloads the sample input file used in examples in the documentation and runs an integration test to verify that sntools works and gives the expected results.

bradkav commented 3 years ago

This looks great to me. I've checked that sntools.setup() works and that the flux files required for the examples are now downloaded. I'll check off the 'tests' and 'examples' items in my review :white_check_mark: