.. _experiments.json#/: experiments =========== .. container:: title A collaboration/experiment/accelerator record This record can describe different types of projects, depending on the value of :ref:`experiments.json#/properties/project_type`. :type: ``object`` :Required: :ref:`experiments.json#/properties/project_type`, :ref:`experiments.json#/properties/_collections` **Properties:** :ref:`experiments.json#/properties/$schema`, :ref:`experiments.json#/properties/_bucket`, :ref:`experiments.json#/properties/_collections`, :ref:`experiments.json#/properties/_full_ingestion`, :ref:`experiments.json#/properties/_private_notes`, :ref:`experiments.json#/properties/accelerator`, :ref:`experiments.json#/properties/collaboration`, :ref:`experiments.json#/properties/control_number`, :ref:`experiments.json#/properties/core`, :ref:`experiments.json#/properties/date_approved`, :ref:`experiments.json#/properties/date_cancelled`, :ref:`experiments.json#/properties/date_completed`, :ref:`experiments.json#/properties/date_proposed`, :ref:`experiments.json#/properties/date_started`, :ref:`experiments.json#/properties/deleted`, :ref:`experiments.json#/properties/deleted_records`, :ref:`experiments.json#/properties/description`, :ref:`experiments.json#/properties/experiment`, :ref:`experiments.json#/properties/external_system_identifiers`, :ref:`experiments.json#/properties/inspire_categories`, :ref:`experiments.json#/properties/inspire_classification`, :ref:`experiments.json#/properties/institutions`, :ref:`experiments.json#/properties/legacy_creation_date`, :ref:`experiments.json#/properties/legacy_name`, :ref:`experiments.json#/properties/legacy_version`, :ref:`experiments.json#/properties/long_name`, :ref:`experiments.json#/properties/name_variants`, :ref:`experiments.json#/properties/new_record`, :ref:`experiments.json#/properties/project_type`, :ref:`experiments.json#/properties/public_notes`, :ref:`experiments.json#/properties/related_records`, :ref:`experiments.json#/properties/self`, :ref:`experiments.json#/properties/urls` .. _experiments.json#/properties/$schema: $schema +++++++ :type: ``string`` :format: ``uri`` :minLength: ``1`` .. _experiments.json#/properties/_bucket: _bucket +++++++ Used by `invenio-records-files` to store information about the bucket attached to this record. .. note:: This field is maintained by `invenio-records-files` and should not be edited manually. :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/_collections: _collections ++++++++++++ .. container:: title Collections to which this record belongs :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **_collections** is: :type: ``string`` :minLength: ``1`` **Allowed values:** - Experiments .. _experiments.json#/properties/_full_ingestion: _full_ingestion +++++++++++++++ .. container:: title Whether to ingest all articles written by this project :type: ``boolean`` .. _experiments.json#/properties/_private_notes: _private_notes ++++++++++++++ .. container:: title List of private notes :MARC: ``595__a``, ``667__a`` These notes are only visible to privileged users, not regular users. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **_private_notes** is: :Reference: :ref:`sourced_value.json#/` .. _experiments.json#/properties/accelerator: accelerator +++++++++++ - If ``accelerator`` is present in :ref:`experiments.json#/properties/project_type`, this field contains information about this accelerator. - If ``experiment`` is present in :ref:`experiments.json#/properties/project_type`, this field refers to the accelerator that provides a beam to this experiment. :type: ``object`` :Required: :ref:`experiments.json#/properties/accelerator/properties/value` **Properties:** :ref:`experiments.json#/properties/accelerator/properties/curated_relation`, :ref:`experiments.json#/properties/accelerator/properties/record`, :ref:`experiments.json#/properties/accelerator/properties/value` .. _experiments.json#/properties/accelerator/properties/curated_relation: curated_relation ################ :type: ``boolean`` .. _experiments.json#/properties/accelerator/properties/record: record ###### If ``accelerator`` is not present in :ref:`experiments.json#/properties/project_type`, this links to the related accelerator record. :Reference: :ref:`experiment.json#/` .. _experiments.json#/properties/accelerator/properties/value: value ##### .. container:: title Accelerator name :MARC: ``119__b`` :example: ``LHC`` :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/collaboration: collaboration +++++++++++++ :MARC: ``710`` - If ``collaboration`` is present in :ref:`experiments.json#/properties/project_type`, this field contains information about this collaboration. - Otherwise, this field refers to the collaboration that runs this accelerator/experiment. :type: ``object`` :Required: :ref:`experiments.json#/properties/collaboration/properties/value` **Properties:** :ref:`experiments.json#/properties/collaboration/properties/curated_relation`, :ref:`experiments.json#/properties/collaboration/properties/record`, :ref:`experiments.json#/properties/collaboration/properties/subgroup_names`, :ref:`experiments.json#/properties/collaboration/properties/value` .. _experiments.json#/properties/collaboration/properties/curated_relation: curated_relation ################ :type: ``boolean`` .. _experiments.json#/properties/collaboration/properties/record: record ###### If ``collaboration`` is not present in :ref:`experiments.json#/properties/project_type`, this links to the related collaboration record. :Reference: :ref:`experiment.json#/` .. _experiments.json#/properties/collaboration/properties/subgroup_names: subgroup_names ############## .. container:: title List of names of subgroups :MARC: ``710__q`` Sometimes papers are signed not by the full collaboration, but only by a more focused subgroup. This records the names of those groups. :example: ``ATLAS TDAQ`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **subgroup_names** is: :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/collaboration/properties/value: value ##### .. container:: title Collaboration name :MARC: ``710__g`` :example: ``D0`` :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/control_number: control_number ++++++++++++++ .. container:: title ID of current record :MARC: ``001`` Read-only field. Also called ``record ID`` or ``recid``. :type: ``integer`` .. _experiments.json#/properties/core: core ++++ :MARC: ``980:CORE`` corresponds to ``true``. Whether the papers written by this project are generally :ref:`hep.json#/properties/core`. :type: ``boolean`` .. _experiments.json#/properties/date_approved: date_approved +++++++++++++ .. container:: title Approval date of experiment/accelerator :MARC: ``046__r`` :type: ``string`` :format: ``date`` :minLength: ``1`` .. _experiments.json#/properties/date_cancelled: date_cancelled ++++++++++++++ .. container:: title Cancellation date of experiment/accelerator :MARC: ``046__c`` :type: ``string`` :format: ``date`` :minLength: ``1`` .. _experiments.json#/properties/date_completed: date_completed ++++++++++++++ .. container:: title Completion date of experiment/accelerator :MARC: ``046__t`` :type: ``string`` :format: ``date`` :minLength: ``1`` .. _experiments.json#/properties/date_proposed: date_proposed +++++++++++++ .. container:: title Proposal date of experiment/accelerator :MARC: ``046__q`` :type: ``string`` :format: ``date`` :minLength: ``1`` .. _experiments.json#/properties/date_started: date_started ++++++++++++ .. container:: title Starting date of experiment/accelerator :MARC: ``046__s`` :type: ``string`` :format: ``date`` :minLength: ``1`` .. _experiments.json#/properties/deleted: deleted +++++++ .. container:: title Whether this record has been deleted :MARC: ``980__a/c:deleted`` :type: ``boolean`` .. _experiments.json#/properties/deleted_records: deleted_records +++++++++++++++ :MARC: ``981__a`` List of records that were deleted because they were replaced by this one. This typically happens when merging two records: one of them gets enriched with the information of the other one, which is then superfluous and gets deleted. For the opposite concept, see :ref:`experiments.json#/properties/new_record`. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **deleted_records** is: :Reference: :ref:`experiment.json#/` .. _experiments.json#/properties/description: description +++++++++++ .. container:: title Description of the project :MARC: ``520__a`` This should take the form of a short text. :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/experiment: experiment ++++++++++ If ``experiment`` is present in :ref:`experiments.json#/properties/project_type`, this field contains information about this experiment. :type: ``object`` **Properties:** :ref:`experiments.json#/properties/experiment/properties/short_name`, :ref:`experiments.json#/properties/experiment/properties/value` .. _experiments.json#/properties/experiment/properties/short_name: short_name ########## :MARC: ``119__d`` :example: ``SHINE`` :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/experiment/properties/value: value ##### .. container:: title Experiment identifier :MARC: ``119__c`` :example: ``NA61`` :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/external_system_identifiers: external_system_identifiers +++++++++++++++++++++++++++ List of identifiers of this document on external systems. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **external_system_identifiers** is: May satisfy *any* of the following definitions: .. _experiments.json#/properties/external_system_identifiers/items/anyOf/0: SPIRES identifier ################# :type: ``object`` .. _experiments.json#/properties/external_system_identifiers/items/anyOf/0/title: :Required: :ref:`experiments.json#/properties/external_system_identifiers/items/anyOf/0/properties/schema`, :ref:`experiments.json#/properties/external_system_identifiers/items/anyOf/0/properties/value` **Properties:** :ref:`experiments.json#/properties/external_system_identifiers/items/anyOf/0/properties/schema`, :ref:`experiments.json#/properties/external_system_identifiers/items/anyOf/0/properties/value` .. _experiments.json#/properties/external_system_identifiers/items/anyOf/0/properties/schema: schema >>>>>> :type: ``string`` :minLength: ``1`` **Allowed values:** - SPIRES .. _experiments.json#/properties/external_system_identifiers/items/anyOf/0/properties/value: value >>>>> :MARC: ``970__a`` :type: ``string`` :pattern: ``^EXPERIMENT-\d+$`` :minLength: ``1`` .. _experiments.json#/properties/inspire_categories: inspire_categories ++++++++++++++++++ :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **inspire_categories** is: :Reference: :ref:`inspire_field.json#/` .. _experiments.json#/properties/inspire_classification: inspire_classification ++++++++++++++++++++++ :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **inspire_classification** is: :MARC: ``372__a`` Category to which this experiment belongs. :type: ``string`` :Reference: :ref:`inspire_experiment_classification.json#/` :minLength: ``1`` .. _experiments.json#/properties/institutions: institutions ++++++++++++ :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **institutions** is: .. container:: title Host institution :type: ``object`` **Properties:** :ref:`experiments.json#/properties/institutions/items/properties/curated_relation`, :ref:`experiments.json#/properties/institutions/items/properties/record`, :ref:`experiments.json#/properties/institutions/items/properties/value` .. _experiments.json#/properties/institutions/items/properties/curated_relation: curated_relation ################ :type: ``boolean`` .. _experiments.json#/properties/institutions/items/properties/record: record ###### .. container:: title Record URI of the institution. :Reference: :ref:`institution.json#/` .. _experiments.json#/properties/institutions/items/properties/value: value ##### .. container:: title ICN of institution hosting the project :MARC: ``119__u`` Currently, the old :ref:`institutions.json#/properties/legacy_ICN` is used here. :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/legacy_creation_date: legacy_creation_date ++++++++++++++++++++ :type: ``string`` :format: ``date`` :minLength: ``1`` .. _experiments.json#/properties/legacy_name: legacy_name +++++++++++ .. container:: title project identifier on legacy INSPIRE :MARC: ``119__a`` :example: ``CERN-LHC-CMS`` :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/legacy_version: legacy_version ++++++++++++++ .. container:: title Last record update :MARC: ``005`` Used to indicate the version of the record on legacy. :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/long_name: long_name +++++++++ .. container:: title long name of the project :MARC: ``245__a`` :example: ``Compact Muon Solenoid`` :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/name_variants: name_variants +++++++++++++ .. container:: title Name variants of the project :MARC: ``419__a`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **name_variants** is: :type: ``string`` :minLength: ``1`` .. _experiments.json#/properties/new_record: new_record ++++++++++ .. container:: title Record replacing this one :MARC: ``970__d`` Contains a reference to the record replacing the current one, if it is marked as :ref:`experiments.json#/properties/deleted`. :Reference: :ref:`experiment.json#/` .. _experiments.json#/properties/project_type: project_type ++++++++++++ .. container:: title Type of project that this record represents :MARC: ``980:ACCELERATOR`` corresponds to an ``accelerator``, otherwise it is an ``experiment``. A project can represent a combination of ``collaboration``, ``accelerator`` and ``experiment``, depending on the contents of this field. Typical cases are: ================= ============== =============== =========== ``collaboration`` ``experiment`` ``accelerator`` explanation ================= ============== =============== =========== present present absent typical case where a collaboration runs a single experiment (e.g. ``ALICE``). present absent absent non-experimental collaboration (e.g. lattice) or experimental collaboration corresponding to several experiments (e.g. ``DO``). absent present absent non-unique experiment among the experiments run by this collaboration (e.g. ``DO Run I``). absent absent present accelerator that is not a collaboration (e.g. ``LHC``). present absent present accelerator that is also a collaboration (e.g. ``CLIC``). ================= ============== =============== =========== - When ``collaboration`` is present, the :ref:`experiments.json#/properties/collaboration` field contains information about it. Otherwise, it might refer to the collaboration record corresponding to the current accelerator/experiment. - When ``experiment`` is present, the :ref:`experiments.json#/properties/experiment` field contains information about it. - When ``accelerator`` is present, the :ref:`experiments.json#/properties/accelerator` field contains information about it. If not, but ``experiment`` is present, it might refer to the accelerator record providing a beam to this experiment. :type: ``array`` :minItems: ``1`` :minLength: ``1`` .. container:: sub-title Every element of **project_type** is: :type: ``string`` :minLength: ``1`` **Allowed values:** - collaboration - experiment - accelerator .. _experiments.json#/properties/public_notes: public_notes ++++++++++++ .. container:: title List of public notes :MARC: ``500`` Any notes about the document that do not fit into another field. .. note:: These notes are publicly visible. For notes not shown to regular users, see :ref:`experiments.json#/properties/_private_notes`. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **public_notes** is: :Reference: :ref:`sourced_value.json#/` .. _experiments.json#/properties/related_records: related_records +++++++++++++++ .. container:: title List of related records :MARC: ``510`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **related_records** is: :Reference: :ref:`related_record.json#/` .. _experiments.json#/properties/self: self ++++ :Reference: :ref:`experiment.json#/` .. _experiments.json#/properties/urls: urls ++++ :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **urls** is: :Reference: :ref:`url.json#/`