MNT: Rename description to descriptor in filename variable #313
Conversation
imap_processing/cdf/utils.py
Outdated
| @@ -41,7 +41,7 @@ def calc_start_time(shcoarse_time: int): | |||
|
|
|||
| def write_cdf( | |||
| data: xr.Dataset, | |||
| description: str = "", | |||
| descriptor: str = "sci", | |||
There was a problem hiding this comment.
To you question, I think we shouldn't make this optional input now since this field is pretty generic and can be so different based on individual instrument.
Or if we put it in dataset.attrs, then we can abstract from that too. But could be up for discussion.
There was a problem hiding this comment.
Or if we put it in dataset.attrs, then we can abstract from that too. But could be up for discussion.
I like this idea, but I am also not sure how it would look because the instrument already has a "Descriptor" which is: "SWE>Solar Wind Electron" which isn't what we want unfortunately.
There was a problem hiding this comment.
OK, I just made it non-optional now. We can look into the attrs idea later.
There was a problem hiding this comment.
that sounds good. I can do that in follow-up PR.
greglucas
merged commit aa30a30
into
IMAP-Science-Operations-Center:dev
…descriptor MNT: Rename description to descriptor in filename variable
Change Summary
Overview
Change "description" to "descriptor" for the filenames.
Additionally,
descriptoris not optional anymore, so set a default ofsciin the field. Or do we want to just force everyone to input this when callingwrite_cdf()?