search

ODM2 / YODA-File

The YAML Observation Data Archive & exchange (YODA) File Format
BSD 3-Clause "New" or "Revised" License
4 stars 0 forks source link

Compact or Expanded Header? #1

Closed horsburgh closed 8 years ago

horsburgh commented 9 years ago

My original question: Are we keeping the expanded header format or the compact header format?

Anthony's response: I think we want to allow both the expanded and compact header formats. The Expanded is much easier to read for simple files. But the Compact is much more... compact... and therefore easier to scroll through for complex files. Also, the compact form is much easier for us to deploy using the excel templates, so we will only output the compact form from Excel templates unless there is a compelling reason to reconsider. Does this make sense?

horsburgh commented 9 years ago

It's potentially OK to support both expanded and compact formats. However, I want to reserve final judgement until I talk to Stephanie and Jacob about how they are parsing using the ODM2 API. The general purpose PyYAML parser doesn't care, but it might be more work to massage both into the ODM2 API object structures. I'll chat with them.

SRGDamia1 commented 9 years ago

The Excel template is currently using the compact form for all fields but the dataset and the citation. I'll change those two field to compact.

horsburgh commented 9 years ago

Thanks Sara. I'm not sure why I left those two blocks in expanded format in my examples, but I have since fixed them. We also had to make some relatively minor changes over the past few days because I hadn't referenced the authors correctly and there were some items in the files that were not named the same as they are named in ODM2. These should all be done in my iUTAH examples now.

horsburgh commented 8 years ago

The new time series template uses compact header format. Closing.