swiss-seismological-service / scdetect

A computationally efficient earthquake detection module for SeisComP
https://scdetect.readthedocs.io
GNU Affero General Public License v3.0
15 stars 6 forks source link

Flawless git clone sequence #141

Closed FMassin closed 1 year ago

FMassin commented 1 year ago
damb commented 1 year ago

Actually the installation instructions were never intended to be simply copy-pastable. While writing the guide I simply followed the approach @luca-s used for scrtdd.

Perhaps, it would be even more intuitive to completely refer to the SeisComP installation documentation, document the SeisComp submodules which are mandatory, and document the git clone command w.r.t. scdetect.

damb commented 1 year ago

BTW, is there a reason to check out a specific tag?

FMassin commented 1 year ago

Yes so that user compiles a version of SeisComP that has been tagged. Intermediary versions in between tags are not released.

FMassin commented 1 year ago

Perhaps, it would be even more intuitive to completely refer to the SeisComP installation documentation, document the SeisComp submodules which are mandatory, and document the git clone command w.r.t. scdetect.

That is too bad because scdetect doesn't need all the stuff (seiscomp sub-modules) to be compiled, it just needs what included in the readme...

damb commented 1 year ago

Yes so that user compiles a version of SeisComP that has been tagged. Intermediary versions in between tags are not released.

That sounds reasonable. Though, I wouldn't specify version 5.3.0 explicitly. This would require to update the installation instructions with every SeisComP release. Instead, I'd go with something like e.g. X.Y.Z including a comment to specify the desired release version.

FMassin commented 1 year ago

Hello!

Ok here it is :)