Rearranging the structure of HALO-DROPS

[tmieslinger]

HALO-DROPS already hosts a lot of super useful information and is deemed to grow. Very personally, I find the current structure slightly unintuitive and would like to suggest a (again very subjective) rearrangement of pages and renaming of some chapters to guide users of different levels through the book.

Generally, I'd stick to the separation into "Operations" and "Data" as introduced on the landing page of the book. Further, I'd remove pages that include intended changes from the rendered book and rather open respective issues that describe the nice features that we dream of, e.g. installing halodrops as a package via pip/mamba.

Below is a first suggestion with chapters and subchapter and I'd be super happy to discuss it further and potentially implement changes if they are decided to be useful.

Suggested new structure

Operations

• Switching on AVAPS
• Pre-flight Operations
• In-flight Operations
• IP Address Setup

Data processing The first page should contain an overview of the halo-drops software package, as well as the data levels and file structure info. Subpages could be the following:

• Level_0 (raw data)
  • copy info from JOANNE paper chapter 2.3.1
• Level_1 (ASPEN processed data)
  • copy info from JOANNE paper chapter 2.3.2
  • (potentially include docker image for processing or manual processing steps with ASPEN)
• Level_2
  • Performance of sondes
• Level_3

Code examples using halodrops Example notebooks for analysing data at different levels, apply further QC, or test and play with the data.

• Get sondes that failed to detect launch
• Quality control of drop sonde data

Contributing to HALO-DROPS

• For developers

to-be-removed

• Delete all the getting started and installation parts and instead add things that currently work and open an issue for future dreams ;-)
• Delete empty files like Reconditioning and dry bias -> rather open an issue instead

[Geet-George]

Hi Theresa, good point! A restructuring of the documentation is probably warranted. I would defer to your expertise here in how books should be structured. :) And I like this proposed new structure.

Just one thing about the Operations part (and I was thinking about this a while ago too)... Maybe we should ask Lutz (or someone else?) how much of this information can be made public, i.e. is there something about HALO operations that needs to be kept out of the public domain?

Meanwhile, we open issues on: (a) Documenting "Reconditioning & dry bias" (b) Documenting "Getting started" (c) Documenting "Installation instructions"

[tmieslinger]

After talking to Helene and Nina, I'll actually rearrange the structure as discussed above and open a respective MR in the next days.