Updated naming and data product versioning conventions #358
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rsation from SDWG meeting on 03/07/24
greglucas
approved these changes
Mar 7, 2024
| * HIT: TBD | ||
| * IDEX: TBD | ||
| * IMAP-Hi: TBD | ||
| * IMAP-Hi: ``45sensor-counts``, ``90sensor-counts``, ``45sensor-flux-3month-map`` (more TBD) |
There was a problem hiding this comment.
I forgot to bring this up on the call today, but for consistency should we put 3month at the end?
flux-map-3month similar to how SWAPI has sci-1min with the frequency last.
cc @tech3371
There was a problem hiding this comment.
That is probably a good idea!
| is also ``YYYYMMDD``. | ||
| * ``<version>`` stores the version of the data product in the format is ``vXX-YY``. See the versioning conventions | ||
| described in the :ref:`data product versioning <Data Product Versioning>` documentation for further details. | ||
| * ``<repointing>`` is an optional component that describes the repointing number, in the format of ``repoint-<num>``, |
There was a problem hiding this comment.
I think we probably want to remove the "-" between repoint and number so it is a single repoint field and the hyphen separates the date and repointing fields.
Suggested change
| * ``<repointing>`` is an optional component that describes the repointing number, in the format of ``repoint-<num>``, | |
| * ``<repointing>`` is an optional component that describes the repointing number, in the format of ``repoint<num>``, |
There was a problem hiding this comment.
Ah yes, good catch.
laspsandoval
pushed a commit
to laspsandoval/imap_processing
that referenced
this pull request
Apr 2, 2024
…date-naming-and-version-conventions Updated naming and data product versioning conventions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Summary
Overview
This PR updates the documents for filenaming and data product versioning conventions based on the conversations during the SDWG meeting on 03/07/2024.
Updated Files
docs/source/development-guide/style-guide/naming-conventions.rstdocs/source/development-guide/style-guide/versioning.rst