usgs / groundmotion-processing

Parsing and processing ground motion data
Other
54 stars 42 forks source link

DOCS: Add tutorial with example of high-level scripting of GMrecordsApp #1004

Closed baagaard-usgs closed 1 year ago

baagaard-usgs commented 1 year ago

Closes #893

baagaard-usgs commented 1 year ago

@emthompson-usgs Including tutorial(s) that download data significantly increases the build time for the documentation. I think we need to cache a small dataset somewhere that we can use for various tutorials. Do we care if the repo is a few MB larger?

baagaard-usgs commented 1 year ago

Will resubmit a PR after combining with update of the CLI tutorial. Both tutorials will use a common cached dataset.

emthompson-usgs commented 1 year ago

@baagaard-usgs Yes, I think having a few MB of cached data for the tutorials is fine. I think that it would be better to put it in a directory outside of src so that it doesn't get included in the wheels.