search

swiss-seismological-service / DUGseis

Software for acquisition and processing of micro-seismic data
Other
9 stars 4 forks source link

JOSS Review: advice for example #14

Open erexer opened 4 days ago

erexer commented 4 days ago

This is for the JOSS Review, but isn't necessary for approval :)

The example has more steps than necessary to run out of the box.

  1. Ideally, you'd have a download command, wget "<url>", so that users don't need to manually go to the site to download the example data.

  2. The example dataset has numerous steps to prepare the download data, it would be a much lower barrier of entry if you set up the example to run out of the box (organize the directory structure, create an empty cache dir, include an .sqlite file, edit the config file to work with the example data) so that all the user has to do is download the zip file, unzip the dir, cd into the dir, install the package, and run the run_postProcessing_PaperExample.py file.

mrosskopf commented 1 day ago

Hi, thanks for the suggestion! I added a new version to zenodo with a zip file, where your point 2 is taken care of and updated the documentation for it as well. I need to have a better look at your first point. For now, I could not download the data via the terminal. Best