Skip to content

README.md describing the SFT file/directory naming scheme

Karl Wette requested to merge ANU-CGA/lalsuite:public-sft-directory-readme into master

Description

Modify lalpulsar_CopyPublicSFTs to write a README.md file describing the SFT file/directory naming scheme into the destination directory. The README.md is no longer written by default, but is included as part of the Doxygen documentation.

The SFT directory naming scheme generates top-level directories which are a little hard to parse, e.g.:

H1_1800SFT_O4RUN+R1+CGDSCALIBSTRAINCLEANGATEDG01+WTKEY5_BROADBAND/...

The README.md is intended to fully describe the top-level naming scheme, and in addition how the SFTs are named and organised into subdirectories.

API Changes and Justification

Backwards Compatible Changes

  • This change does not modify any class/function/struct/type definitions in a public C header file or any Python class/function definitions
  • This change adds new classes/functions/structs/types to a public C header file or Python module

Backwards Incompatible Changes

  • This change modifies an existing class/function/struct/type definition in a public C header file or Python module
  • This change removes an existing class/function/struct/type from a public C header file or Python module

If any of the Backwards Incompatible check boxes are ticked please provide a justification why this change is necessary and why it needs to be done in a backwards incompatible way.

Review Status

cc @keith-riles @david-keitel

Edited by Karl Wette

Merge request reports