Skip to content

Commit

Permalink
update docs with the definition of the old:new mapping
Browse files Browse the repository at this point in the history
  • Loading branch information
scarlehoff committed Nov 14, 2023
1 parent 61dcb9e commit 0ac4832
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions doc/sphinx/source/data/new-commondata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,14 @@ Where all observables contained in one hepdata entry are separated by their obse
Each folder will contain one single metadata file named ``metadata.yaml`` which defines all observables implemented for a given dataset.

In order to keep backward compatibility and ease the comparison between new and old commondata, the ``buildmaster/dataset_names.yml`` file keeps a mapping of the datasets implemented in both formats.
When a ``legacy`` variant is available, the usage of the old name automatically enables such variants.
When a ``legacy`` variant is available, the usage of the old name automatically enables such variants. The format of this mapping is as follow (which enables using variants):

.. code-block:: yaml
old_name_1: new_name_1
old_name_2:
dataset: new_name_2
variant: this_particular_variant
Metadata Format
Expand Down Expand Up @@ -45,7 +52,7 @@ This ``metadata.yaml`` file contains a first portion of general information whic
experiment: "EXPERIMENT_NAME"
implemented_observables:
- observable_name: "OBS"
- observable_name: "OBS"
observable:
description: "Description of the observable"
label: "Latex label for the observable"
Expand Down

0 comments on commit 0ac4832

Please sign in to comment.