Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make "time", "dt", "timeOffset" and "timeUnitSI" optional #201

Open
wants to merge 1 commit into
base: upcoming-2.0.0
Choose a base branch
from
Open

Make "time", "dt", "timeOffset" and "timeUnitSI" optional #201

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions STANDARD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,9 +233,10 @@ Required Attributes for the `basePath`
--------------------------------------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title in line 232 still reads "Required" :)
Do we want to make this optional or recommended?


In addition to holding information about the iteration, each series of
files (`fileBased`) or series of groups (`groupBased`) should have
attributes that describe the current time and the last
time step.
files (`fileBased`) or series of groups (`groupBased`) can have
attributes that describe the current time and the last time step. (In the
case where each iteration corresponds to a different time.) Thus, the
following attributes are *optional*:

- `time`
- type: *(floatX)*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's fix the typo in line 264 at the same time: conversion factor

Copy link
Member

@ax3l ax3l Nov 1, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

timeUnitSI should be made optional as well but required if time or dt is set

Expand Down Expand Up @@ -661,6 +662,7 @@ Reminder: for scalar records the `record` itself is also the `component`.

- `timeOffset`
- type: *(floatX)*
- scope: *optional* (only used if `time` and `dt` are used)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe let's move this from Required for each Record to a section optional (or recommended if we decide so).

- description: the offset between the time at which this record is
defined and the `time` attribute of the `basePath` level.
This should be written in the same unit system as `time`
Expand Down