experiments

A collaboration/experiment/accelerator record

This record can describe different types of projects, depending on the value of project_type.

type:object
Required:project_type, _collections

Properties: $schema, _bucket, _collections, _full_ingestion, _private_notes, accelerator, collaboration, control_number, core, date_approved, date_cancelled, date_completed, date_proposed, date_started, deleted, deleted_records, description, experiment, external_system_identifiers, inspire_categories, inspire_classification, institutions, legacy_creation_date, legacy_name, legacy_version, long_name, name_variants, new_record, project_type, public_notes, related_records, self, urls

$schema

type:string
format:uri
minLength:1

_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

_collections

Collections to which this record belongs
type:array
minItems:1
Every element of _collections is:
type:string
minLength:1

Allowed values:

  • Experiments

_full_ingestion

Whether to ingest all articles written by this project
type:boolean

_private_notes

List of private notes
MARC:595__a, 667__a

These notes are only visible to privileged users, not regular users.

type:array
minItems:1
Every element of _private_notes is:
Reference:sourced_value

accelerator

  • If accelerator is present in project_type, this field contains information about this accelerator.
  • If experiment is present in project_type, this field refers to the accelerator that provides a beam to this experiment.
type:object
Required:value

Properties: curated_relation, record, value

curated_relation

type:boolean

record

If accelerator is not present in project_type, this links to the related accelerator record.

Reference:experiment

value

Accelerator name
MARC:119__b
example:LHC
type:string
minLength:1

collaboration

MARC:710
  • If collaboration is present in project_type, this field contains information about this collaboration.
  • Otherwise, this field refers to the collaboration that runs this accelerator/experiment.
type:object
Required:value

Properties: curated_relation, record, subgroup_names, value

curated_relation

type:boolean

record

If collaboration is not present in project_type, this links to the related collaboration record.

Reference:experiment

subgroup_names

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
Every element of subgroup_names is:
type:string
minLength:1

value

Collaboration name
MARC:710__g
example:D0
type:string
minLength:1

control_number

ID of current record
MARC:001

Read-only field. Also called record ID or recid.

type:integer

core

MARC:980:CORE corresponds to true.

Whether the papers written by this project are generally core.

type:boolean

date_approved

Approval date of experiment/accelerator
MARC:046__r
type:string
format:date
minLength:1

date_cancelled

Cancellation date of experiment/accelerator
MARC:046__c
type:string
format:date
minLength:1

date_completed

Completion date of experiment/accelerator
MARC:046__t
type:string
format:date
minLength:1

date_proposed

Proposal date of experiment/accelerator
MARC:046__q
type:string
format:date
minLength:1

date_started

Starting date of experiment/accelerator
MARC:046__s
type:string
format:date
minLength:1

deleted

Whether this record has been deleted
MARC:980__a/c:deleted
type:boolean

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 new_record.

type:array
minItems:1
Every element of deleted_records is:
Reference:experiment

description

Description of the project
MARC:520__a

This should take the form of a short text.

type:string
minLength:1

experiment

If experiment is present in project_type, this field contains information about this experiment.

type:object

Properties: short_name, value

short_name

MARC:119__d
example:SHINE
type:string
minLength:1

value

Experiment identifier
MARC:119__c
example:NA61
type:string
minLength:1

external_system_identifiers

List of identifiers of this document on external systems.

type:array
minItems:1
Every element of external_system_identifiers is:

May satisfy any of the following definitions:

SPIRES identifier

type:object
Required:schema, value

Properties: schema, value

schema

type:string
minLength:1

Allowed values:

  • SPIRES

value

MARC:970__a
type:string
pattern:^EXPERIMENT-\d+$
minLength:1

inspire_categories

type:array
minItems:1
Every element of inspire_categories is:
Reference:inspire_field

inspire_classification

type:array
minItems:1
Every element of inspire_classification is:
MARC:372__a

Category to which this experiment belongs.

type:string
Reference:inspire_experiment_classification
minLength:1

institutions

type:array
minItems:1
Every element of institutions is:
Host institution
type:object

Properties: curated_relation, record, value

curated_relation

type:boolean

record

Record URI of the institution.
Reference:institution

value

ICN of institution hosting the project
MARC:119__u

Currently, the old legacy_ICN is used here.

type:string
minLength:1

legacy_creation_date

type:string
format:date
minLength:1

legacy_name

project identifier on legacy INSPIRE
MARC:119__a
example:CERN-LHC-CMS
type:string
minLength:1

legacy_version

Last record update
MARC:005

Used to indicate the version of the record on legacy.

type:string
minLength:1

long_name

long name of the project
MARC:245__a
example:Compact Muon Solenoid
type:string
minLength:1

name_variants

Name variants of the project
MARC:419__a
type:array
minItems:1
Every element of name_variants is:
type:string
minLength:1

new_record

Record replacing this one
MARC:970__d

Contains a reference to the record replacing the current one, if it is marked as deleted.

Reference:experiment

project_type

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 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 experiment field contains information about it.
  • When accelerator is present, the 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
Every element of project_type is:
type:string
minLength:1

Allowed values:

  • collaboration
  • experiment
  • accelerator

public_notes

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 _private_notes.

type:array
minItems:1
Every element of public_notes is:
Reference:sourced_value

self

Reference:experiment

urls

type:array
minItems:1
Every element of urls is:
Reference:url