Skip to content

Docs for new commondata format

Emanuele Roberto Nocera requested to merge document_new_commondata_format into master

Created by: scarlehoff

I've added a first draft of the new commondata format. This deals with #1691 (closed).

At the moment I've only added a description that follows the implementation of @t7phy in #1684. I believe the format is now more or less final (we are at a point where we are deciding whether it should be written definition or definitions so really the details).

Since I was at it I've changed what @cschwan had added about the naming convention to rst. I've added in the new-commondata.rst file the sentence:

In all cases one can reconstruct the name of the folder by separating the observable name on the last ``_``

which si what we discussed yesterday.

Please feel free to add new documents to this PR, there are many things missing (a TODO below, feel free to add more items by editing this comment).

TODO:

  • Format of the theory definition
  • Motivation etc
  • Tools to facilitate the hepdata integration
  • Integrating it with the rest of the documentation
  • Utilities and implementation of new files

Merge request reports