What would you like to see added to the NWBInspector?
There is a best practice section currently on units of measurement (https://nwbinspector.readthedocs.io/en/dev/best_practices/time_series.html#units-of-measurement) for the units field of any TimeSeries.
@weiglszonja Recently found some examples worth bringing up regarding this.
(a) where they use the British spellingof the words, e.g., 'metres' instead of 'meters'. We should probably decide and specify in the Best Practices whether to use American (which is what we normally suggest) or British spelling, since this can have an impact on machine readability down the line.
(b) with respect to abbreviations, we could also just enforce people to use standard SI abbreviations, i.e, 'meters' -> 'm'
(c) we also need to decide the official BP way of specifying division quantities, such as 'meters per second' or in combination with (b), 'm/s', which is what we've typically used ourselves.
Also it would be cool if we had a check that ensures the unit field follows SI units, but not sure what the best way to do that would be other than hard coding all the different SI base types separated from prefixes ('meters', 'second', 'volts', 'amperes', etc.)
Pseudocode or other logic of the check
No response
Do you have any interest in helping implement the check function?
Yes.
Code of Conduct
What would you like to see added to the NWBInspector?
There is a best practice section currently on units of measurement (https://nwbinspector.readthedocs.io/en/dev/best_practices/time_series.html#units-of-measurement) for the
unitsfield of anyTimeSeries.@weiglszonja Recently found some examples worth bringing up regarding this.
(a) where they use the British spellingof the words, e.g., 'metres' instead of 'meters'. We should probably decide and specify in the Best Practices whether to use American (which is what we normally suggest) or British spelling, since this can have an impact on machine readability down the line.
(b) with respect to abbreviations, we could also just enforce people to use standard SI abbreviations, i.e, 'meters' -> 'm'
(c) we also need to decide the official BP way of specifying division quantities, such as 'meters per second' or in combination with (b), 'm/s', which is what we've typically used ourselves.
Also it would be cool if we had a check that ensures the unit field follows SI units, but not sure what the best way to do that would be other than hard coding all the different SI base types separated from prefixes ('meters', 'second', 'volts', 'amperes', etc.)
Pseudocode or other logic of the check
No response
Do you have any interest in helping implement the check function?
Yes.
Code of Conduct