Documentation on web page

NCAR / ucomp-pipeline

Data processing pipeline for UCoMP

Other

6 stars 3 forks source link

Documentation on web page #154

Closed jburkepile closed 11 months ago

jburkepile commented 1 year ago

Please list documents / info that we want to have on web page; added to tarball files downloaded by user and for publications.

[x] put the current version in resource/docs/ucomp-user-guide.v1.0.pdf

[!NOTE] Time estimate: Put time estimate here.

detoma commented 1 year ago

Ideally, we would like an instrument paper, a short data guide, and a more in depth data guide.

Only the short data guide is required for commissioning, in my opinion. We can add the rest later.

bberkeyU commented 1 year ago

What sections do we want to see in the short guide? Something graphical like the CoMP data guide.

Intro to ucomp (I am thinking of the abstract for one of our UCoMP posters)
Table of lines observed with ucomp
Description of L2 files. (We need to agree on what these are first) Quick_Invert, Mean/Median, Combined Dynamics/Polarization, etc. Including extension names.

Do we want to touch on L0 or L1? What is missing?

mgalloy commented 1 year ago

I think it would be cool to have a short guide that is designed by Don. Maybe just 1-2 pages that would give just the basic reason to use the data and the basics on how to use the data along with some nice images.

jburkepile commented 1 year ago

Agree with Mike's and Ben's comments. In addition to Ben's list I would add a description of the Level 1 files and a succinct list of the data processing steps with a link to the github pipeline pages. It would also be good to include a link to the UCoMP instrument page. Need to ask Steve what documents he wants to add to the instrument page.

We can note that more detailed documentation is in progress.

bberkeyU commented 11 months ago

https://docs.google.com/document/d/1Lt2b4gx6GR1Wq8z1B0ceQKB0-PBCdGUCmPIKeIOlHQ0/edit