Closed kadrlica closed 6 years ago
@yymao we should add descriptions for the categories themselves (i.e., Models, Probes, Measurements, Targets). Would it be better to do this in the Categories
section -- i.e.,
Categories:
- Models
description: A "model" is a theoretical framework describing the physical mechanism governing the microphysics of dark matter. Examples: warm dark matter, axion dark matter, primordial black hole dark matter, etc.
- Probes
- Measurements
- Targets
or in the individual section for each category -- i.e.
Models:
description: A "model" is a theoretical framework describing the physical mechanism governing the microphysics of dark matter. Examples: warm dark matter, axion dark matter, primordial black hole dark matter, etc.
- key: wdm
label: Warm dark matter
description: >-
Dark matter that acts like a thermal particle
with mass less than 1 GeV.
...
Probably in Categories, if each category instance already has description levels. What else could be added within the Categories block?
Yes, should put in the Categories section. Should format similarly as the nodes, i.e.:
Categories:
- label: Models
description: A "model" is a theoretical framework describing the physical mechanism governing the microphysics of dark matter. Examples: warm dark matter, axion dark matter, primordial black hole dark matter, etc.
- label: Probes
I've updated the Categories
section to mirror other nodes:
Categories:
- key: models
label: Models
description: >-
A "model" is a theoretical framework describing the physical
mechanism governing the microphysics of dark matter. Examples:
warm dark matter, axion dark matter, primordial black hole dark
matter, etc.
@johannct other elements of the Categories
section could define appearance (i.e., color, fontsize, etc.) or additional content (we imagine the description as a mouse-over tooltip, but we may want to add more).
@kadrlica should we then use the key
field in the rest of the yaml file? i.e.,
models:
- key: sidm
#...
probes:
#...
@yymao I'm not sure I understand the question. I thought the key
field was your addition, so I assumed that this is what we wanted. I believe this is the current format of the other sections
Ok, offline chat resolved this. The point is that subsequent sections should match the key
rather than the label
in the Categories
section. In actuality, this is a change in capitalization.
This issue (and associated branch) have focused more on the format of the yaml file than the content. As such, I'm going to close this issue and start a new, more general branch for tracking input data.
We need to add content to and cross check the content of
data.yaml
. This includes: