bluesky / event-model

data model for event-based data collection and analysis
https://blueskyproject.io/event-model
BSD 3-Clause "New" or "Revised" License
13 stars 30 forks source link

ENH: add schema for "projection" entry in start document #130

Open tacaswell opened 4 years ago

tacaswell commented 4 years ago

Provide a semantic mapping of the keys in the collected data to a known set of keys drawn from an externally owned vocabulary.

danielballan commented 4 years ago

This PR could use a description or a link to some meeting notes if there are any.

danielballan commented 4 years ago

On a Pilot call @dylanmcreynolds nudged us to move forward with this. I am personally happy with it but given the importance and the cost of any future changes I think we should have at least one more meeting to pick apart the structure and the names and consider alternatives.

danielballan commented 4 years ago

:+1: for @stuartcampbell's request to use this on a fully-worked example or three before we commit to it.

danielballan commented 4 years ago

@tacaswell on Slack:

move "techniques" out of start document and into [its] own document class

danielballan commented 4 years ago

I am in favor of proceeding on this but doing so in a separate experimental document type that can evolve quickly and make breaking changes as needed. I think @tacaswell suggested this in passing on Slack, as I tersely documented at the time, above.

danielballan commented 4 years ago

There was a call on this subject today.

Things there seemed to be strong consensus on:

Things that might need more thought or discussion to build strong consensus:

Things that need investigation:

prjemian commented 4 years ago

First off, can someone please edit the top box here and describe clearly the intent of this PR, as previously requested? Without this focus stated, the discussion is not focused.

dylanmcreynolds commented 4 years ago

I have heard taht NeXus has deprecated XML backends. This leads to the question of how much XML you plan to support transforming to? Namespacing is great, but there seems to be a huge debate on how or if to represent that in JSON. It seems like you could punt on some complexity if you don't intend to output XML.

prjemian commented 4 years ago

That's right. HDF5 is now the only supported on-disk format for NeXus data files. The decision to drop the XML backend was between 2012 and 2014-08. (Can't find the specific decision in the notes yet.)