Documentation Priorities

[bjfultn]

• installation instructions
  • database
  • files that are needed
• description of recipes and configs
• operations instructions
• algorithmic descriptions
• docstrings for everything
• documentation for consumers
  • high level descriptions of the algorithms
• tutorial for reducing a night
• how to interpret logs

[MNBrod]

Adding:

• Descriptions of what env variables actually mean (e.g. KPF_TESTDATA isn't really test data anymore)
• Descriptions of where to find data within the data products (probably just fleshing out https://california-planet-search-kpf-pipeline.readthedocs-hosted.com/en/latest/data_exploration/start.html with high level overview oriented towards non-KPF-expert scientists) @awhoward may have more to say here
• Picking a night of data to use as an example, I will work on getting that made public and linkable
• We need a block of text that can be used as a citation by users. This can be a direct citation if there is one (BibTeX is ideal), or a boilerplate acknowledgement for users to copy. See PypeIt's for an example

[awhoward]

Let's discuss at an upcoming DRP meeting what else is needed for DRP documentation.