inspire-schemas

https://img.shields.io/travis/inspirehep/inspire-schemas.svg https://img.shields.io/coveralls/inspirehep/inspire-schemas.svg https://img.shields.io/github/tag/inspirehep/inspire-schemas.svg https://img.shields.io/pypi/dm/inspire-schemas.svg https://img.shields.io/github/license/inspirehep/inspire-schemas.svg

Inspirehep schemas and related tools bundle.

User’s Guide

This part of the documentation will show you how to get started in using inspire-schemas.

NOTE: it is highly encouraged to pin the version of inspire-schemas that you use to the major number, for example using the ~= version matcher in your requirements.txt or your setup.py like:

inspire-schemas~=1.0.0

That will prevent any major update (compatibility breaking) to be pulled automatically, and will only download minor and feature updates (1.X.Y).

Installation

pip install inspire-schemas

Usage

Schemas and utilities used in inspirehep.

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

API Docs

Public api for methods and functions to handle/verify the jsonschemas.

Utils Docs

Public api for methods and functions to handle/verify the jsonschemas.

class inspire_schemas.utils.LocalRefResolver(base_uri, referrer, store=(), cache_remote=True, handlers=(), urljoin_cache=None, remote_cache=None)[source]

Bases: jsonschema.validators.RefResolver

Simple resolver to handle non-uri relative paths.

resolve_remote(uri)[source]

Resolve a uri or relative path to a schema.

inspire_schemas.utils.build_pubnote(title, volume, page_start, page_end, artid)[source]

Build pubnote string from parts (reverse of split_pubnote).

inspire_schemas.utils.classify_field(value)[source]

Normalize value to an Inspire category.

Parameters:value (str) – an Inspire category to properly case, or an arXiv category to translate to the corresponding Inspire category.
Returns:
None if value is not a non-empty string,
otherwise the corresponding Inspire category.
Return type:str
inspire_schemas.utils.convert_new_publication_info_to_old(publication_infos)[source]

Convert back a publication_info value from the new format to the old.

Does the inverse transformation of convert_old_publication_info_to_new(), to be used whenever we are sending back records from Labs to Legacy.

Parameters:publication_infos – a publication_info in the new format.
Returns:a publication_info in the old format.
Return type:list(dict)
inspire_schemas.utils.convert_old_publication_info_to_new(publication_infos)[source]

Convert a publication_info value from the old format to the new.

On Legacy different series of the same journal were modeled by adding the letter part of the name to the journal volume. For example, a paper published in Physical Review D contained:

{
    'publication_info': [
        {
            'journal_title': 'Phys.Rev.',
            'journal_volume': 'D43',
        },
    ],
}

On Labs we instead represent each series with a different journal record. As a consequence, the above example becomes:

{
    'publication_info': [
        {
            'journal_title': 'Phys.Rev.D',
            'journal_volume': '43',
        },
    ],
}

This function handles this translation from the old format to the new. Please also see the tests for various edge cases that this function also handles.

Parameters:publication_infos – a publication_info in the old format.
Returns:a publication_info in the new format.
Return type:list(dict)
inspire_schemas.utils.get_license_from_url(url)[source]

Get the license abbreviation from an URL.

Parameters:url (str) – canonical url of the license.
Returns:the corresponding license abbreviation.
Return type:str
Raises:ValueError – when the url is not recognized
inspire_schemas.utils.get_schema_path(schema, resolved=False)[source]

Retrieve the installed path for the given schema.

Parameters:
  • schema (str) – relative or absolute url of the schema to validate, for example, ‘records/authors.json’ or ‘jobs.json’, or just the name of the schema, like ‘jobs’.
  • resolved (bool) – if True, the returned path points to a fully resolved schema, that is to the schema with all $ref replaced by their targets.
Returns:

path to the given schema name.
Return type:

str
Raises:

SchemaNotFound – if no schema could be found.
inspire_schemas.utils.load_schema(schema_name, resolved=False)[source]

Load the given schema from wherever it’s installed.

Parameters:
  • schema_name (str) – Name of the schema to load, for example ‘authors’.
  • resolved (bool) – If True will return the resolved schema, that is with all the $refs replaced by their targets.
Returns:

the schema with the given name.
Return type:

dict
inspire_schemas.utils.normalize_arxiv_category(category)[source]

Normalize arXiv category to be schema compliant.

This properly capitalizes the category and replaces the dash by a dot if needed. If the category is obsolete, it also gets converted it to its current equivalent.

Example

>>> from inspire_schemas.utils import normalize_arxiv_category
>>> normalize_arxiv_category('funct-an')
u'math.FA'
inspire_schemas.utils.normalize_collaboration(collaboration)[source]

Normalize collaboration string.

Parameters:collaboration – a string containing collaboration(s) or None
Returns:List of extracted and normalized collaborations
Return type:list

Examples

>>> from inspire_schemas.utils import normalize_collaboration
>>> normalize_collaboration('for the CMS and ATLAS Collaborations')
['CMS', 'ATLAS']
inspire_schemas.utils.split_page_artid(page_artid)[source]

Split page_artid into page_start/end and artid.

inspire_schemas.utils.split_pubnote(pubnote_str)[source]

Split pubnote into journal information.

inspire_schemas.utils.valid_arxiv_categories()[source]

List of all arXiv categories that ever existed.

Example

>>> from inspire_schemas.utils import valid_arxiv_categories
>>> 'funct-an' in valid_arxiv_categories()
True
inspire_schemas.utils.validate(data, schema=None)[source]

Validate the given dictionary against the given schema.

Parameters:
  • data (dict) – record to validate.
  • schema (Union[dict, str]) – schema to validate against. If it is a string, it is intepreted as the name of the schema to load (e.g. authors or jobs). If it is None, the schema is taken from data['$schema']. If it is a dictionary, it is used directly.
Raises:
  • SchemaNotFound – if the given schema was not found.
  • SchemaKeyNotFound – if schema is None and no $schema key was found in data.
  • jsonschema.SchemaError – if the schema is invalid.
  • jsonschema.ValidationError – if the data is invalid.

Schemas Reference

Auto-generated documentation for Inspirehep schemas.

Schemas Documentation

builders

records

authors
type:object
Required:name, _collections

Properties: $schema, _collections, _private_notes, acquisition_source, advisors, arxiv_categories, birth_date, conferences, control_number, death_date, deleted, deleted_records, email_addresses, experiments, ids, inspire_categories, legacy_creation_date, name, native_name, new_record, other_names, past_emails_addresses, positions, previous_names, prizes, public_notes, self, source, status, stub, urls

$schema
type:string
format:url
_collections
Collections to which record belongs
type:array
minItems:1
Every element of _collections is:
type:string

Allowed values:

  • Authors
_private_notes
type:array
Every element of _private_notes is:
Reference:sourced_value
acquisition_source
Reference:acquisition_source
advisors
type:array
Every element of advisors is:
type:object

Properties: curated_relation, degree_type, ids, name, record

curated_relation
type:boolean
degree_type
Reference:degree_type
ids
type:array
Every element of ids is:
Reference:id
name
type:string
record
Reference:json_reference
arxiv_categories
type:array
Every element of arxiv_categories is:
Reference:arxiv_categories
birth_date

Stores birth date

type:string
format:date
conferences

Contains information about attended conferences. (their record URIs)

type:array
Every element of conferences is:
Reference:json_reference
control_number
type:integer
death_date

Stores death date (if any)

type:string
format:date
deleted
type:boolean
deleted_records
Deleted Records

List of deleted records referring to this record

type:array
Every element of deleted_records is:
Reference:json_reference
email_addresses

Contains current email addresses

type:array
Every element of email_addresses is:
type:string
format:email
experiments

Contains information about experiments.

type:array
Every element of experiments is:
type:object

Properties: curated_relation, current, end_year, name, record, start_year

curated_relation
type:boolean
current
type:boolean
end_year
type:integer
name
type:string
record

URI for the experiment record

Reference:json_reference
start_year
type:integer
ids
type:array
Every element of ids is:
Reference:id
inspire_categories
type:array
Every element of inspire_categories is:
Reference:inspire_field
legacy_creation_date
type:string
format:date
name

Contains name information.

type:object
Required:value

Properties: numeration, preferred_name, title, value

numeration
type:string

Allowed values:

  • Jr.
  • Sr.
  • I
  • II
  • III
  • IV
  • VI
  • VII
  • VIII
preferred_name
type:string
title
type:string

Allowed values:

  • Sir
value
type:string
format:.+, .+
native_name

Stores name in native form.

type:array
Every element of native_name is:
type:string
new_record
New record

Master record that replaces this record

Reference:json_reference
other_names

Contains other variation of names. Usually a different form of writing the primary name.

type:array
Every element of other_names is:
type:string
past_emails_addresses

Contains past email addresses

type:array
Every element of past_emails_addresses is:
type:string
format:email
positions
type:array
Every element of positions is:
type:object

Properties: _rank, current, emails, end_date, institution, old_emails, rank, start_date

_rank
type:string
current
type:boolean
emails
type:array
Every element of emails is:
type:string
format:email
end_date
type:string
format:date
institution
type:object

Properties: curated_relation, name, record

curated_relation
type:boolean
name
type:string
record
Reference:json_reference
old_emails
type:array
Every element of old_emails is:
type:string
format:email
rank
Reference:rank
start_date
type:string
format:date
previous_names

Contains a previous name. For example, it can be a maiden’s name.

type:array
Every element of previous_names is:
type:string
prizes

Contains prize name.t

type:array
Every element of prizes is:

E.g. Nobel Prize Physics 1977, Shaw Prize 2006, Sakurai Prize 1985 FIXME: shall we separate the year?

type:string
public_notes
type:array
Every element of public_notes is:
Reference:sourced_value
self
Url of the record

Url of the record itself

Reference:json_reference
source

This is the source of informatio. It is currently a mixed bags of user IDs or provenance information, e.g. arXiv etc. FIXME: we should really discuss about it. E.g. eprint, webform, Rachel.Lumpkin@durham.ac.uk(96), Fermilab, C09-05-04, KYOTOU...

type:array
Every element of source is:
type:object

Properties: date_verified, name

date_verified
type:string
format:date
name
type:string
status

The person’s status

type:string

Allowed values:

  • active
  • deceased
  • departed
  • retired
stub
type:boolean
urls
type:array
Every element of urls is:
Reference:url
conferences
Conference
type:object
Required:_collections

Properties: $schema, _collections, _private_notes, acronyms, address, alternative_titles, closing_date, cnum, contact_details, control_number, deleted, deleted_records, external_system_identifiers, inspire_categories, legacy_creation_date, new_record, opening_date, public_notes, self, series, short_description, titles, urls

$schema
type:string
format:url
_collections
Collections to which this record belongs
type:array
minItems:1
Every element of _collections is:
type:string

Allowed values:

  • Conferences
_private_notes
List of private notes
MARC:595

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

type:array
Every element of _private_notes is:
Reference:sourced_value
acronyms
List of acronyms of the conference
type:array
Every element of acronyms is:
Conference acronym
MARC:111__e
example:SUSY 2018
type:string
address
List of locations of the conference
MARC:111__c (in the form city, country), 270__b

This field is a list because a conference can sometimes be split among several cities.

Note

The postal_address should not be provided for a conference.

type:array
Every element of address is:
Reference:address
alternative_titles
MARC:711

Sometimes conferences are known by several titles/acronyms. These name variants can be provided here.

Note

If a conference has several titles or acronyms, it is more appropriate to use titles or :acronyms.

This field is meant mainly to port information from legacy, that was not categorized well into title/acronym variants and was used to boost search results.

type:array
List of alternative titles
Every element of alternative_titles is:
Reference:title
closing_date
Conference closing date

111__y

type:string
format:date
cnum
CNUM of the conference
Reference:cnum
contact_details
Contact information
MARC:270
type:array
Every element of contact_details is:
Reference:contact
control_number
ID of current record
MARC:001

Read-only field.

type:integer
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
Every element of deleted_records is:
Reference:json_reference
external_system_identifiers

List of identifiers of this document on external systems.

type:array
Every element of external_system_identifiers is:

May satisfy any of the following definitions:

0
type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • SPIRES
value
MARC:970__a
type:string
pattern:^CONF-\d+$
inspire_categories
type:array
Every element of inspire_categories is:
Reference:inspire_field
legacy_creation_date
type:string
format:date
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:json_reference
opening_date
Conference opening date
MARC:111__x
type:string
format:date
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
Every element of public_notes is:
Reference:sourced_value
self
Reference:json_reference
series
Conference series that this is part of
MARC:411
type:array
Every element of series is:
type:object
Required:name

Properties: name, number

name
Name of the conference series

411__a

type:string
number
Number of the conference in the series

411__n

type:integer
short_description
Reference:sourced_value
titles
List of titles of the conference
MARC:111__a/b
type:array
Every element of titles is:
Reference:title
urls
type:array
Every element of urls is:
Reference:url
data
A data record

Schema is not yet specified

type:object
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, _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, long_name, name_variants, new_record, project_type, public_notes, related_records, self, urls

$schema
type:string
format:url
_collections
Collections to which this record belongs
type:array
Every element of _collections is:
type:string

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
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:json_reference
value
Accelerator name
MARC:119__b
example:LHC
type:string
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:json_reference
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
Every element of subgroup_names is:
type:string
value
Collaboration name
MARC:710__g
example:D0
type:string
control_number
ID of current record
MARC:001

Read-only field.

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
date_cancelled
Cancellation date of experiment/accelerator
MARC:046__c
type:string
format:date
date_completed
Completion date of experiment/accelerator
MARC:046__t
type:string
format:date
date_proposed
Proposal date of experiment/accelerator
MARC:046__q
type:string
format:date
date_started
Starting date of experiment/accelerator
MARC:046__s
type:string
format:date
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
Every element of deleted_records is:
Reference:json_reference
description
Description of the project
MARC:520__a

This should take the form of a short text.

type:string
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
value
Experiment identifier
MARC:119__c
example:NA61
type:string
external_system_identifiers

List of identifiers of this document on external systems.

type:array
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

Allowed values:

  • SPIRES
value
MARC:970__a
type:string
pattern:^EXPERIMENT-\d+$
inspire_categories
type:array
Every element of inspire_categories is:
Reference:inspire_field
inspire_classification
type:array
Every element of inspire_classification is:
MARC:372__a

Category to which this experiment belongs. The possible values can be found on the experiment categories page on legacy.

example:3.1.1 for ultra-short baseline, reactor, neutrino (flavor) experiment
type:string
pattern:\d+(\.\d+){0, 2}
institutions
type:array
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:json_reference
value
ICN of institution hosting the project
MARC:119__u

Currently, the old legacy_ICN is used here.

type:string
legacy_creation_date
type:string
format:date
legacy_name
project identifier on legacy INSPIRE
MARC:119__a
example:CERN-LHC-CMS
type:string
long_name
long name of the project
MARC:245__a
example:Compact Muon Solenoid
type:string
name_variants
Name variants of the project
MARC:419__a
type:array
Every element of name_variants is:
type:string
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:json_reference
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
minLength:1
Every element of project_type is:
type:string

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
Every element of public_notes is:
Reference:sourced_value
self
Reference:json_reference
urls
type:array
Every element of urls is:
Reference:url
hep
A record in the Literature collection
type:object
Required:document_type, titles, _collections

Properties: $schema, _collections, _desy_bookkeeping, _export_to, _files, _private_notes, abstracts, accelerator_experiments, acquisition_source, arxiv_eprints, authors, book_series, citeable, collaborations, control_number, copyright, core, corporate_author, curated, deleted, deleted_records, document_type, documents, dois, editions, energy_ranges, external_system_identifiers, figures, funding_info, imprints, inspire_categories, isbns, keywords, languages, legacy_creation_date, license, new_record, number_of_pages, persistent_identifiers, preprint_date, public_notes, publication_info, publication_type, record_affiliations, refereed, references, related_records, report_numbers, self, texkeys, thesis_info, title_translations, titles, urls, withdrawn

$schema
type:string
format:url
_collections
Collections to which this record belongs
MARC:980__a (HEP maps to Literature)

Regular Literature records have collection Literature only.

The other collections are used by different groups to manage records using the Inspire infrastructure, but which do not belong to the Inspire literature collection. If a record belongs to one of these collections but not Literature, it is not shown in the standard search results.

type:array
Every element of _collections is:
type:string

Allowed values:

  • BABAR Analysis Documents
  • BABAR Internal BAIS
  • BABAR Internal Notes
  • CDF Internal Notes
  • CDF Notes
  • CDS Hidden
  • D0 Internal Notes
  • D0 Preliminary Notes
  • H1 Internal Notes
  • H1 Preliminary Notes
  • HAL Hidden
  • HEP Hidden
  • HERMES Internal Notes
  • LArSoft Internal Notes
  • LArSoft Notes
  • Literature
  • ZEUS Internal Notes
  • ZEUS Preliminary Notes
_desy_bookkeeping
DESY keywording information
MARC:595_D

Used by DESY to store information about the keyword-assignment process.

type:array
Every element of _desy_bookkeeping is:
type:object

Properties: date, expert, status

date
MARC:595_Dd
type:string
expert
MARC:595_Da
type:string
status
MARC:595_Ds
type:string
_export_to
MARC:595__c

Flags determining to which foreign databases this record should be automatically exported. Setting one of the keys to true means that the record must be exported to the corresponding system, setting it to false means that it must not be exported.

type:object

Properties: CDS, HAL

CDS

Controls automatic export to the CERN Document Server.

type:boolean
HAL

Controls automatic export to HAL, the French national repository.

type:boolean
_files
invenio-records-files metadata

Used by invenio-records-files to store information about the files attached to this record.

Note

This field is maintained by invenio-records-files and should not be edited manually.

type:array
Every element of _files is:
Reference:records-files
_private_notes
List of private notes
MARC:595, 595_H (when source is HAL)

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

type:array
Every element of _private_notes is:
Reference:sourced_value
abstracts
List of abstracts
MARC:520
type:array
Every element of abstracts is:
Reference:sourced_value
accelerator_experiments
List of related accelerators/experiments
type:array
Every element of accelerator_experiments is:
type:object

Properties: accelerator, curated_relation, experiment, institution, legacy_name, record

accelerator
MARC:693__a

If present, institution should contain the institution where this accelerator is located.

Note

Currently not used, see legacy_name.

type:string
curated_relation
type:boolean
default:False
experiment
MARC:not present.

If present, institution should contain the institution where this experiment is located and accelerator may contain the accelerator that this experiment is using (if appropriate).

Note

Currently not used, see legacy_name.

type:string
institution
Institution hosting the experiment
MARC:not present.

Note

Currently not used, see legacy_name.

type:string
legacy_name
Identifier of the experiment on legacy
MARC:693__e

This field is used when migrating from legacy instead of separate institution, accelerator and experiment. In the future, it will be deprecated and the other fields will be used instead.

example:CERN-LHC-CMS
type:string
record
Reference:json_reference
acquisition_source
Reference:acquisition_source
arxiv_eprints
type:array
Every element of arxiv_eprints is:
arXiv metadata

Contains metadata of an arXiv eprint contained in this record.

Note

This metadata is copied over from arXiv and should not be edited manually.

type:object
Required:categories, value

Properties: categories, value

categories
arXiv categories of the eprint
MARC:first category in 037__c with 9:arXiv, all categories in 65017a with 2:arXiv

The first category in the list has a special meaning: it is the primary category of the eprint on arXiv.

type:array
minItems:1
Every element of categories is:
Reference:arxiv_categories
value
arXiv eprint identifier
MARC:037__a with 9:arXiv
example:math/0307245
example:1701.01431
type:string
pattern:^\d{4}.\d{4, 5}|[\w.]+(-[\w.]+)?/\d+$
authors
Authors
MARC:100, 700 and 701

Besides authors, also contains editors and supervisors (see inspire_roles).

type:array
Every element of authors is:
type:object
Required:full_name

Properties: affiliations, alternative_names, credit_roles, curated_relation, emails, full_name, ids, inspire_roles, raw_affiliations, record, signature_block, uuid

affiliations
type:array
Every element of affiliations is:
type:object
Required:value

Properties: curated_relation, record, value

curated_relation
type:boolean
record
Reference:json_reference
value
ICN of affiliation
MARC:100/700/701__u

Currently, the old legacy_ICN is used here. In the future, this will change and become the new ICN.

type:string
alternative_names
type:array
Every element of alternative_names is:
MARC:100/700/701__q
example:楼 立洋
example:Smith, Joe John
type:string
credit_roles
type:array
Every element of credit_roles is:
CRedit role of author
MARC:not present.

Role of the author according to the Contributor Roles Taxonomy (CRediT)

type:string

Allowed values:

  • Conceptualization
  • Data curation
  • Formal analysis
  • Funding acquisition
  • Investigation
  • Methodology
  • Project administration
  • Resources
  • Software
  • Supervision
  • Validation
  • Visualization
  • Writing - original draft
  • Writing - review & editing
curated_relation
type:boolean
default:False
emails
MARC:100/700/701__m
type:array
Every element of emails is:
type:string
format:email
full_name
Author name
MARC:100/700/701__a

Author name in Latin alphabet (may contain diacritics). Should be of the form ‘family names, first names’, and, except for a possible reordering, be exactly as on the paper.

example:Smith Davis, John F.K.
type:string
ids
Identifiers of the author
MARC:100/700/701__i/j
type:array
Every element of ids is:
Reference:id
inspire_roles
type:array
Every element of inspire_roles is:
supervisor
MARC:701 is used for supervisor metadata.

This person is a thesis supervisor. Should be used together with the thesis document_type.

editor
MARC:100/700__e:ed.

This person is an editor of the conference proceedings. Should be used together with the proceedings document_type.

type:string
default:author

Allowed values:

  • author
  • supervisor
  • editor
raw_affiliations
MARC:100/700/701__v

List of full affiliations, as written on the paper.

type:array
Every element of raw_affiliations is:
Reference:sourced_value
record
Reference:json_reference
signature_block

Phonetic representation of the name, needed for author disambiguation. This field should not be edited manually.

type:string
uuid
UUID

Used by the BEARD author disambiguation tool. This field should not be edited manually.

type:string
pattern:^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
book_series
MARC:490

List of book series in which this record has been published.

Note

This field should only be present if book, thesis or proceedings are among document_type.

type:array
Every element of book_series is:

Note

If the book series has a Journal record, hep.json#/properties/publication_info should be used instead.

type:object

Properties: title, volume

title
Title of the book series
MARC:490__a
type:string
volume
Volume of the book in the series
MARC:490__v
type:string
citeable
MARC:true corresponds to 980__a:Citeable.

The main effect of setting this field to true is that the recoord is taken into account in the citation summary. The need for this field arises because of limitations in the automatic recognition of cited papers in references: a record is flagged as citeable only if the common way to cite this record can be reliably recognized. Currently, a record is automatically flagged as citeable if it has

Besides, a record may be manually flagged as citeable by a curator if a user tracks and reports citations to that record.

type:boolean
Whether this record should be considered as citeable
collaborations
List of collaborations
type:array
Required:value
Every element of collaborations is:
type:object

Properties: record, value

record
Reference:json_reference
value
Collaboration name
MARC:710__g

Collaboration name as it appears on the paper (with the Collaboration suffix dropped).

example:ATLAS instead of ATLAS Collaboration
example:Particle Data Group
type:string
control_number
ID of current record
MARC:001

Read-only field.

type:integer
core
Whether this record is CORE

Inspire ingests metadata and creates records for many documents. Some of them are relevant for High-Energy Physics, wheareas others might be only tangentially related. In the first case, the record is said to be CORE, whereas in the second case it is non-core. CORE records are manually curated to ensure their metadata are up to Inspire’s quality standards, but non-core records only receive automatic treatment.

Note

If this field is not present or set to false, the record is considered as non-core. The latter is useful to override automatic core assignments based on other properties of the record.

type:boolean
corporate_author
type:array
Every element of corporate_author is:
List of corporate authors
MARC:110__a

In case the document has not been signed by a real author, but only mentions the name of an organization.

example:CERN
type:string
curated
MARC:500__a containing *Temporary entry*, *Temporary record* or *Brief entry* correspond to false, otherwise it is true.

Whether this record has been curated by a human, to ensure the quality standards of Inspire. Records having the core flag are all curated eventually, whereas non-core records are not systematically curated.

type:boolean
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
Every element of deleted_records is:
Reference:json_reference
document_type
MARC:980__a, with corresponding values.

Types of document this record represents.

Note

As a record aggregates information from multiple sources, it can have multiple document types simultaneously.

article
An article, whether it is published or only a preprint. In the first case, publication_info contains information about the journal in which it was published.
book

A monograph that does not fit into any other document_type. The editions, imprints, isbns and book_series fields may contain specific metadata about this book.

Note

A proceeding or a thesis is not considered as a book.

book chapter
A chapter in a book. The field publication_info contains information about the book of which this record is a chapter.
conference paper
A paper that part of a conference proceedings. The field publication_info contain information about the conference proceedings. In particular, cnum contains the identifier of the conference.
note
A note, not meant for publication.
proceedings

Proceedings of a conference. The cnum field contains the identfier of the conference. If published in a journal, publication_info also contains the journal information. If published as a book, the editions, imprints, isbns and book_series fields may contain specific metadata about this book.

Note

This is not considered as a book.

report
A report.
thesis

A thesis. The thesis_info field contains additional information about the thesis. If published as a book, the editions, imprints, isbns and book_series fields may contain specific metadata about this book.

Note

This is not considered as a book.

type:array
minItems:1
Every element of document_type is:
Reference:document_type
documents
List of documents attached to the record
MARC:8564 (if the URL points to the inspire server)
type:array
Every element of documents is:
type:object
Required:key, url

Properties: description, fulltext, hidden, key, material, original_url, source, url

description
MARC:8564_y

Describes how this document relates to the document that this record represents. :example: table of contents

type:string
fulltext
Whether this document contains the fulltext
type:boolean
hidden
Whether this document is hidden

This is true if a document is attached to the record for automatic extraction of metadata, but Inspire is not allowed to make it publicly available.

type:boolean
key

Key to the corresponding file, which must match the key in _files.

type:string
material
Reference:material
original_url
Original URL of the document
type:string
format:url
source
Reference:source
url
MARC:8564_u

Relative URL to the file containing the document. Its form is /files/bucket/key. It can temprorarily be the url to download the document from, until actually downloaded.

type:string
format:url
dois
List of DOIs
type:array
Every element of dois is:
type:object
Required:value

Properties: material, source, value

material
MARC:0247_q
Reference:material
source
MARC:0247_9
Reference:source
value
DOI
MARC:0247_a
example:10.1023/A:1026654312961
type:string
pattern:^10\.\d+(\.\d+)?/.+$
editions
List of book editions
MARC:250__a
type:array
Every element of editions is:
type:string
energy_ranges
MARC:695__e:n corresponds to the n-th range in the enum, e.g. 695__e:2 is 3-10 Gev`.

Ranges of energies the record refers to. The ranges are inclusive on the right.

example:100-300 GeV means that 100 GeV < Energy ≤ 300 GeV.
type:array
Every element of energy_ranges is:
type:string

Allowed values:

  • 0-3 GeV
  • 3-10 GeV
  • 10-30 GeV
  • 30-100 GeV
  • 100-300 GeV
  • 300-1000 GeV
  • 1-10 TeV
  • > 10 TeV
external_system_identifiers
MARC:035

List of identifiers of this document on external systems.

type:array
Every element of external_system_identifiers is:
type:object
Required:schema, value

Properties: schema, value

schema
MARC:035__9

Identifies the external system, and allows to interpret unambiguously the value.

example:ADS
type:string
value
External identifier
MARC:035__a

Identifies the record in the external system specified by schema.

example:1999IJTP...38.1113M
type:string
figures
List of figures attached to the record

Note

The order in which the figures appear in this list is the same as in the fulltext.

type:array
Every element of figures is:
type:object
Required:key, url

Properties: caption, key, label, material, source, url

caption
MARC:8564_y (without the five-digit counter)
type:string
key

Key to the corresponding file, which matches a key in _files.

type:string
label

Label used to refer to this figure in the document.

type:string
material
MARC:not present (figures were extracted only from arXiv preprints)
Reference:material
source
Reference:source
url
MARC:8564_u

Relative URL to the file containing the figure. Its form is /files/bucket/key.

type:string
format:url
funding_info
Funding information
MARC:536

Information about the sources of funding for the research performed in this record.

type:array
Every element of funding_info is:
type:object

Properties: agency, grant_number, project_number

agency
Funding agency
MARC:536__a
type:string
grant_number
Grant number
MARC:536__c
type:string
project_number
Project number
MARC:536__f
type:string
imprints
List of imprints
type:array
Every element of imprints is:
MARC:260

When/where/by whom this record was published.

type:object

Properties: date, place, publisher

date
Date of publication
MARC:260__c
type:string
format:date
place
Place of publication
MARC:260__a

Note

This field is populated if this record has been published in a book, i.e. it makes sense if book, thesis or proceedings are among document_type.

example:Paris
type:string
publisher
MARC:260__b
example:Springer
type:string
inspire_categories
List of Inspire categories
type:array
Every element of inspire_categories is:
Reference:inspire_field
isbns
List of ISBNs
MARC:020
type:array
Every element of isbns is:
type:object
Required:value

Properties: medium, value

medium
Physical medium to which this ISBN refers
MARC:020__b
type:string

Allowed values:

  • hardcover
  • online
  • print
  • softcover
value
MARC:020__a
example:0201021153
type:string
pattern:^\d*[0-9X]$
keywords
List of keywords
MARC:084, 6531 and 695 (corresponding to different schema)

Keywords give information about the specific contents of the record, much more precisely than inspire_categories.

type:array
Every element of keywords is:
type:object
Required:value

Properties: schema, source, value

schema
Keyword vocabulary

Describes to which vocabulary the keyword in value belongs.

INIS
MARC:695__2:INIS

The keyword is part of the International Nuclear Information System (INIS) vocabulary.

INSPIRE
MARC:695__2:INSPIRE

The keyword has been assigned by Inspire, and belongs to its vocabulary.

JACOW
MARC:6531_2:JACOW

The keyword is part of the Joint Accelerator Conference Website (JACoW) vocabulary.

PACS
MARC:084__2:PACS

The keyword is a number from the Physics and Astronomy Classification Scheme (PACS).

PDG
MARC:084__2:PDG

The keyword is a PDG Indentifier.

Note

If not present, the keyword is a free-form keyword, not necessarily part of any vocabulary.

type:string

Allowed values:

  • INIS
  • INSPIRE
  • JACOW
  • PACS
  • PDG
source
Reference:source
value
A keyword
MARC:084/6531/695__a (depending on schema)

It belongs to the vocabulary specified by schema.

example:black hole: mass (for schema = INSPIRE)
example:29.27.Fh (for schema = PACS)
example:G033M (for schema = PDG)
type:string
languages
List of languages of the document
MARC:041__a

Note

If this field is not present, the language of the document is assumed to be English.

type:array
Every element of languages is:
Reference:language_code
legacy_creation_date
Date of record creation on legacy
MARC:961__x

Only present if the record already existed on legacy Inspire.

type:string
format:date
license
List of licenses
MARC:540
type:array
Every element of license is:
type:object

Properties: imposing, license, material, url

imposing
Organization/person imposing the license
MARC:540__b
example:arXiv
type:string
license
License statement
MARC:540__a

Either the short name of the license or the full license statement.

example:CC-BY-4.0
type:string
material
MARC:540__3
Reference:material
url
URL of the license
MARC:540__u

URL where the full license statement may be found, if only a short name is provided in license.

type:string
format:url
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:json_reference
number_of_pages
Number of pages of the document
MARC:300
type:integer
minimum:1
persistent_identifiers
List of persistent identifiers
MARC:0247
type:array
Every element of persistent_identifiers is:
type:object
Required:schema, value

Properties: material, schema, source, value

material
Reference:material
schema
Type of identifier
MARC:0247_2

Currently, the following identifiers are recognized:

Note

DOIs should be put into dois, not here.

Although ISBNs can also be mapped to a URN (by prepending urn:isbn: to the ISBN), they should be put in the isbns field instead.

type:string

Allowed values:

  • HDL
  • URN
source
Reference:source
value
Persistent identifier
MARC:0247_a

This value gets interpreted as an identfier of the type specified by schema.

example:10138/168995 (when schema = HDL)
example:urn:nbn:de:hebis:77-diss-1000009520 (when schema = URN)
type:string
preprint_date
Preprint release date
MARC:269__c

Note

This is only for preprints. For the publication date of published documents, see imprints.

type:string
format:date
public_notes
List of public notes
MARC:500

Any notes about the document that do not fit into another field. For arXiv eprints, also contains the contents of the comment field on arXiv.

Note

These notes are publicly visible. For notes not shown to regular users, see _private_notes.

type:array
Every element of public_notes is:
Reference:sourced_value
publication_info
List of information on publication
MARC:773
type:array
Every element of publication_info is:
type:object

Properties: artid, cnum, conf_acronym, conference_record, curated_relation, hidden, journal_issue, journal_record, journal_title, journal_volume, material, page_end, page_start, parent_isbn, parent_record, parent_report_number, pubinfo_freetext, year

artid
Article ID
MARC:773__c (when it contains an ID instead of starting page or page range).

For journals which issue IDs for articles instead of (or in complement to) continuous numbers within a volume.

Note

On legacy, this was treated as a starting page.

type:string
cnum
MARC:773__w

When conference` paper` or ``proceedings is among document_type, contains the CNUM of the corresponding conference.

Reference:cnum
conf_acronym
Conference acronym
MARC:773__q
type:string
conference_record
record of the conference
Reference:json_reference
curated_relation
type:boolean
hidden
Whether this publication_info should be hidden
MARC:If true, this comes comes from 7731 instead of 773.

This is useful when:

  • there are variants in the way this publication is cited,
  • an error was present, has been fixed, but should be preserved
    in order to find the record.
type:boolean
journal_issue
MARC:773__n
type:string
journal_record

Record of the corresponding Journal

Reference:json_reference
journal_title
MARC:773__p

Journal title abbreviated as in the corresponding entry in the Journals collection.

example:Phys.Rev.
type:string
journal_volume
MARC:773__v
type:string
material
MARC:773__m
Reference:material
page_end
Last page of document
MARC:last page in 773__c (if present)
type:string
page_start
First page of document
MARC:first page in 773__c (if not an artid)
type:string
parent_isbn
MARC:773__z

ISBN of the book of which this document is a part.

type:string
pattern:^\d*[0-9X]$
parent_record
Reference:json_reference
parent_report_number
MARC:773__r

Report number of the document of which this record is a part. This applies e.g. for large reports containing several chapters that have been split into individual records.

type:string
pubinfo_freetext
MARC:773__x

Unstructured text describing the publication information.

Note

This field is used when provided with unstructured publication information, e.g. from arXiv. If known, the other fields should be used instead.

type:string
year
Publication year
MARC:773__y
type:integer
minimum:1000
maximum:2050
publication_type
type:array
Every element of publication_type is:
type:string

Allowed values:

  • introductory
  • lectures
  • review
record_affiliations
Affiliations not associated to authors
MARC:902

Because of technical limitations, for some older records the affiliations were associated globally to the record instead of its individual authors (using the affiliations field).

Note

This field is present for legacy records and should not be used for new records.

type:array
Every element of record_affiliations is:
type:object
Required:value

Properties: curated_relation, record, value

curated_relation
type:boolean
record
Reference:json_reference
value
ICN of affiliation
MARC:902__a

Currently, the old legacy_ICN is used here. In the future, this will change and become the new ICN.

type:string
refereed
Whether the record has been peer reviewed
MARC:true corresponds to 980__a:published

This asserts that the document is considered as peer reviewed. This assessment might differ from the journal’s claim to do peer review. As a consequence, most conference papers are not considered as refereed.

type:boolean
references
List of references
MARC:999C5
type:array
Every element of references is:
type:object

Properties: curated_relation, legacy_curated, raw_refs, record, reference

curated_relation
type:boolean
legacy_curated
MARC:999C59:CURATOR corresponds to True

Whether the reference has been modified be a curator to correct errors in reference extraction from the document.

type:boolean
raw_refs
List of raw references
MARC:999C5x

These references are unparsed and as they appear in the document.

type:array
Every element of raw_refs is:
type:object
Required:value, schema

Properties: schema, source, value

schema
Content type of the raw reference
example:text
example:Elsevier XML
type:string
source
Reference:source
value
Content of the raw reference
type:string
record
MARC:999C50
Reference:json_reference
reference
Reference:reference
report_numbers
List of report numbers assigned to the record
MARC:037
example:DESY-17-036
type:array
Every element of report_numbers is:
type:object
Required:value

Properties: hidden, source, value

hidden
MARC:if true, the value is in 037__z instead of 037__a.

Whether this report number should be hidden from the display. This is appropriate for:

  • a report number that appears on the document but is not the one officially assigned;
  • a report number that has been assigned by one of the authors’ institutions, but is not displayed on the document (typically for large collaborations).
type:boolean
source
Reference:source
value
type:string
self
Reference:json_reference
texkeys
List of TeX keys
MARC:035 with 9:SPIRESTeX or 9:INSPIRETeX

These keys are used to cite this record using TeX/LaTeX/BibTex. The first one is the valid one being shown in the TeX display formats, the others are the obsolete ones which are kept in order to identify this record by those texkeys.

type:array
Every element of texkeys is:
type:string
thesis_info
MARC:502

Information on a thesis (degree, date, university)

type:object

Properties: date, defense_date, degree_type, institutions

date
MARC:502__d

Publication date of the thesis

type:string
format:date
defense_date
MARC:500__a

Date of the thesis defense. On legacy, this was put in the note field as ‘presented on ...’.

type:string
format:date
degree_type
MARC:502__b
Reference:degree_type
institutions
MARC:502__c

List of institutions issuing the degree.

type:array
Every element of institutions is:
type:object

Properties: curated_relation, name, record

curated_relation
type:boolean
name
type:string
record
Reference:json_reference
title_translations
MARC:242

Translations of the titles in a language that is not the language of the document (see languages). Usually, this is contains an English translation of the title of a non-English paper, but sometimes a native language if the paper is in English but the title has been translated.

type:array
Every element of title_translations is:
type:object

Properties: language, source, subtitle, title

language
Reference:language_code
source
Reference:source
subtitle
type:string
title
type:string
titles
MARC:245

There can be several because the preprint title often differs from the published version. The title should be kept as on the document and in the same language as the document (see languages).

Translations go into title_translations.

type:array
List of titles
Every element of titles is:
Reference:title
urls
MARC:8564

URLs to external resources related to this record.

Note

Links to internal resources are found in figures or documents.

type:array
Every element of urls is:
Reference:url
withdrawn
MARC:true corresponds to 980__a:withdrawn

Whether the paper has been withdrawn (mainly occurs for arXiv preprints). It shouldn’t appear in author profiles.

type:boolean
institutions
A record representing an Institution
type:object
Required:_collections

Properties: $schema, ICN, _collections, _private_notes, addresses, control_number, core, deleted, deleted_records, external_system_identifiers, extra_words, historical_data, inactive, inspire_categories, institution_hierarchy, institution_type, legacy_ICN, legacy_creation_date, name_variants, new_record, public_notes, related_records, self, urls

$schema
type:string
format:url
ICN
List of affiliation identifiers
MARC:110__t

HEP affiliation unique identifier following the general pattern institution name, city, department. This was called the “new ICN” on legacy.

Note

This is a list in case the ICN needs to be updated because of a mistake in its assignment. The current one is the first element of the list.

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

Allowed values:

  • Institutions
_private_notes
List of private notes
MARC:595, 667

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

type:array
Every element of _private_notes is:
Reference:sourced_value
addresses
List of addresses
MARC:371 (secondary addresses contain an x subfield)

The primary address is the first in the list, the secondary addresses, if present, come next. This might happen for instance for institutions distributed on several campuses.

type:array
Every element of addresses is:
Reference:address
control_number
ID of current record
MARC:001

Read-only field.

type:integer
core
Whether this institution is CORE
MARC:980:CORE corresponds to true.
type:boolean
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
Every element of deleted_records is:
Reference:json_reference
external_system_identifiers
MARC:035, 970

List of identifiers of this institution on external systems.

type:array
Every element of external_system_identifiers is:

May satisfy any of the following definitions:

HAL identifier
type:object
Required:schema, value

Properties: schema, value

schema
MARC:035__9:HAL
type:string

Allowed values:

  • HAL
value
MARC:035__a
type:string
pattern:^\d+$
SPIRES identifier
type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • SPIRES
value
MARC:970__a
type:string
pattern:^INST-\d+$
extra_words
Extra words
MARC:410__g

Contains extra words that might be used when searching for this record, but that are not contained in the other visible metadata.

type:array
Every element of extra_words is:
type:string
historical_data
Historical information about institution
MARC:6781_a
type:array
Every element of historical_data is:
type:string
inactive
MARC:980:DEAD corresponds to true

Whether this institution is not active any more, and hence authors of recent articles cannot have it as an affiliation.

type:boolean
inspire_categories
List of Inspire categories
type:array
Every element of inspire_categories is:
Reference:inspire_field
institution_hierarchy
MARC:110__a/b

This record can represent a department, or a group within a department, as opposed to a complete institution. To represent that fact, this field contains the names and acronyms of the specific institution that this record represents, followed by its parents, from most specific to least specific.

example:
[
    {
        "name": "Stanford Synchrotron Radiation Lightsource",
        "acronym": "SSRL"
    },
    {
        "name": "SLAC National Accelerator Laboratory",
        "acronym": "SLAC"
    }
]
type:

array
Every element of institution_hierarchy is:
type:object

Properties: acronym, name

acronym
MARC:in parenthesis at the end of 110_a/b
type:string
name
MARC:value in 110_a/b, excluding final parenthesis
type:string
institution_type
MARC:372__a
type:array
Every element of institution_type is:
type:string

Allowed values:

  • University
  • Research Center
  • Company
  • Other
legacy_ICN
MARC:110__u

This was called simply “ICN” on legacy.

type:string
legacy_creation_date
Date of record creation on legacy
MARC:961__x

Only present if the record already existed on legacy Inspire.

type:string
format:date
name_variants
MARC:410__a

Variants of the institution name. This is used when alternative names are in common use, possibly in English when the official name is not.

type:array
Every element of name_variants is:
Reference:sourced_value
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:json_reference
public_notes
List of public notes
MARC:680

Any notes about the document that do not fit into another field. For arXiv eprints, also contains the contents of the comment field on arXiv.

Note

These notes are publicly visible. For notes not shown to regular users, see _private_notes.

type:array
Every element of public_notes is:
Reference:sourced_value
self
Reference:json_reference
urls
type:array
Every element of urls is:
Reference:url
jobs
HEP Job
type:object
Required:_collections

Properties: $schema, _collections, _private_notes, address, closed_date, contact_details, control_number, deadline_date, deleted, deleted_records, description, experiments, external_system_identifiers, inspire_categories, institutions, legacy_creation_date, new_record, position, public_notes, ranks, reference_email, regions, self, urls

$schema
type:string
format:url
_collections
Collections to which this record belongs
type:array
minItems:1
Every element of _collections is:
type:string

Allowed values:

  • Jobs
_private_notes
type:array
Every element of _private_notes is:
Reference:sourced_value
address
type:array
Every element of address is:
Reference:address
closed_date
Date when the job was closed
type:string
format:date
contact_details
type:array
Every element of contact_details is:
Reference:contact
control_number
type:integer
deadline_date
Application deadline
type:string
format:date
deleted
type:boolean
deleted_records
Deleted Records

List of deleted records referring to this record

type:array
Every element of deleted_records is:
Reference:json_reference
description
Job description
type:string
experiments
type:array
Every element of experiments is:
Experiments associated with Job
type:object

Properties: curated_relation, name, record

curated_relation
type:boolean
name
Experiment name
type:string
record
Experiment Record URI
Reference:json_reference
external_system_identifiers
type:array
Every element of external_system_identifiers is:

May satisfy any of the following definitions:

0
type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • SPIRES
value
type:string
pattern:^JOBS-\d+$
inspire_categories
type:array
Every element of inspire_categories is:
Reference:inspire_field
institutions
type:array
Every element of institutions is:
Institution
type:object

Properties: curated_relation, name, record

curated_relation
type:boolean
name
Institution name
type:string
record
Institution Record URI
Reference:json_reference
legacy_creation_date
type:string
format:date
new_record
New record

Master record that replaces this record

Reference:json_reference
position
Job position
type:string
public_notes
type:array
Every element of public_notes is:
Reference:sourced_value
ranks
type:array
Every element of ranks is:
Reference:rank
reference_email
type:array
Every element of reference_email is:
Reference email

FIXME: what is the difference from contact_email!?

type:string
format:email
regions
type:array
Every element of regions is:
type:string

Allowed values:

  • Africa
  • Australasia
  • Asia
  • Europe
  • Middle East
  • North America
  • South America
self
Url of the record

Url of the record itself

Reference:json_reference
urls
type:array
Every element of urls is:
Reference:url
journals
A record representing a Journal
type:object
Required:journal_title, short_title, _collections

Properties: $schema, _collections, _harvesting_info, _private_notes, book_series, control_number, date_ended, date_started, deleted, deleted_records, doi_prefixes, inspire_categories, issns, journal_title, legacy_creation_date, license, new_record, proceedings, public_notes, publisher, refereed, related_records, self, short_title, title_variants, urls

$schema
type:string
format:url
_collections
Collections to which this record belongs
type:array
minItems:1
Every element of _collections is:
type:string

Allowed values:

  • Journals
_harvesting_info
MARC:583

Metadata about the harvesting process of this journal.

type:object

Properties: coverage, date_last_harvest, last_seen_item, method

coverage
MARC:583__a

Whether all articles are automatically added to Inspire (full) or a selection is made (partial).

type:string

Allowed values:

  • full
  • partial
date_last_harvest
MARC:583__c

Date on which the most recent harvest was performed.

Note

This date does not necessarily mean that any records were created on that day. This can happen if there was no journal update since the previous time, or that the update did not have any relevant effect for Inspire.

type:string
format:date
last_seen_item
MARC:583__3

Information about last processed item in the harvest. This item can be a volume, an issue or even a specific article.

type:string
method
MARC:583__i

How the harvesting is performed. Possible values are:

feed
Inspire receives a feed with publisher updates.
harvest
harvesting is done through webscraping.
print
articles are picked manually from the printed journal.
hepcrawl
harvesting is done through a native hepcrawl spider.
type:string

Allowed values:

  • feed
  • harvest
  • print
  • hepcrawl
_private_notes
List of private notes
MARC:595__a, 667__x

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

type:array
Every element of _private_notes is:
Reference:sourced_value
book_series
MARC:980__a:BookSeries corresponds to true

Whether this “journal” is actually a serial whose volumes are books, i.e. a book series.

type:boolean
control_number
ID of current record
MARC:001

Read-only field.

type:integer
date_ended
MARC:Not present.

Date of last publication of the journal.

type:string
format:date
date_started
MARC:Not present.

Date of first publication of the journal.

type:string
format:date
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
Every element of deleted_records is:
Reference:json_reference
doi_prefixes
List of DOI prefixes for this journal
MARC:677__d

This DOI prefix is the common start of DOIs in this journals, that all articles share.

Note

This is a list because journals can change publishers, and the new publisher will often assign new DOIs in its own prefix.

type:array
Every element of doi_prefixes is:
type:string
pattern:^10\.\d+(\.\d+)?/.*$
inspire_categories
List of Inspire categories
type:array
Every element of inspire_categories is:
Reference:inspire_field
issns
List of ISSNs
MARC:022
type:array
Every element of issns is:
type:object
Required:value

Properties: medium, value

medium
Physical medium to which this ISSN refers
MARC:022__b
type:string

Allowed values:

  • online
  • print
value
MARC:022__a
example:0295-5075
type:string
pattern:^\d{4}-\d{3}[\dX]$
journal_title
Reference:title
MARC:130
legacy_creation_date
Date of record creation on legacy
MARC:961__x

Only present if the record already existed on legacy Inspire.

type:string
format:date
license
MARC:540
type:object

Properties: license, url

license
License statement
MARC:540__a

Either the short name of the license or the full license statement.

example:CC-BY-4.0
type:string
url
URL of the license
MARC:540__u

URL where the full license statement may be found, if only a short name is provided in license.

type:string
format:url
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:json_reference
proceedings
MARC:690__a:Proceedings corresponds to true

Whether this journal publishes conference proceedings. If it publishes both conference proceedings and peer reviewed articles (depending on issue), both this field and refereed are true.

type:boolean
public_notes
List of public notes
MARC:500__a, 640__a, 680__i

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
Every element of public_notes is:
Reference:sourced_value
publisher
List of publishers
MARC:643__b

The first element of the list is the current publisher of the journal.

Note

This is a list because journals can change publishers.

type:array
Every element of publisher is:
type:string
refereed
MARC:690__a:Peer review corresponds to true, 690__a:NON-PUBLISHED to false

Whether this journal is considered to perform peer review. This assessment might differ from the journal’s.

If the journal does not publish proceedings proceedings, all articles in it are flagged as refereed. Otherwise, it is only the case if the article is not a conference paper.

type:boolean
self
Reference:json_reference
short_title
MARC:711__a

Normalized title of the journal

example:Phys.Rev. D
type:string
title_variants
List of journal name variants
MARC:730__a

These name variants appear in references and are used to properly recognize citations.

example:PHYS REVIEW
type:array
Every element of title_variants is:
type:string
urls
type:array
Every element of urls is:
Reference:url

elements

acquisition_source
Origin of the metadata in the record
MARC:541

Only the first source is stored: if the record later gets enriched with metadata coming from a second source, the acquisition_source is not updated.

type:object

Properties: datetime, email, internal_uid, method, orcid, source, submission_number

datetime
Date on which the metadata was obtained
MARC:541__d

This does not necessarily coincide with the creation date of the record, as there might be some delay between the moment the original information is obtained and a record is finally created in the system.

type:string
format:date-time
email
Email address associated to the submitter’s account
MARC:541__b

This only gets populated when method is submitter.

type:string
format:email
internal_uid
Inspire user ID of the submitter
MARC:541__a with inspire:uid: prefix.

This only gets populated when method is submitter.

type:integer
method
How the medata was obtained

Possible values are:

submitter
when obtained from a user submission. In this case, orcid, internal_uid and email store identifiers of the submitter, and submission_number an ID of the submission.
oai
when obtained by OAI-PMH harvesting.
batchuploader
when obtained through the batch uploader.
hepcrawl
when obtained from a hepcrawl crawler. In this case, source stores the publisher or the repository that was crawled.
type:string

Allowed values:

  • submitter
  • oai
  • batchuploader
  • hepcrawl
orcid
ORCID of the submitter
MARC:541__a with orcid: prefix

This only gets populated when method is submitter.

type:string
pattern:^\d{4}-\d{4}-\d{4}-\d{3}[0-9X]$
source
Reference:source
submission_number
Holding pen record ID of the submission
MARC:541__e

This only gets populated when method is submitter.

type:string
address
Location associated to the record
type:object

Properties: cities, country_code, latitude, longitude, place_name, postal_address, postal_code, state

cities
List of cities

Sometimes conferences and institutes are officially located in a little-known place, but their location is widely known as being in a major neighboring city. In this way, we can store information about both the technically correct but little-known place and the well-known but technically incorrect place.

The cities should be ordered from most specific to least specific.

example:["Batavia", "Chicago"]
type:array
Every element of cities is:
A city
example:Geneva
type:string
country_code
Reference:country_code
latitude
Latitude of the location
example:50.7736
type:number
longitude
Longitude of the location
example:6.07532
type:number
place_name

Name of the specific place where this is located.

  • For a Conference record, this could be an institution or a hotel hosting the conference.
    MARC:270__b
    example:Dan Panorama hotel
  • For an Institution record representing an independent institute and not a department, this could be a university where it is located.
    MARC:Not present.
    example:U. Libre Brussels
type:string
postal_address

Full postal address in the original language, with one element for every line, but excluding the country.

example:["Notkestraße 85", "22607 Hamburg"]

Note

This is used for Institution records, but not for Conferences.

type:array
Every element of postal_address is:
type:string
postal_code
Postal code of the location
example:1050
type:string
state
State or province of the location

For American states, standard 2-letter codes are used.

example:TX
type:string
arxiv_categories

A category that currently exists on arXiv. Note that some categories have been renamed and are not in this list. These are taken from the arXiv API documentation.

example:math.FA instead of its previous name, funct-an
type:string

Allowed values:

  • astro-ph
  • astro-ph.CO
  • astro-ph.EP
  • astro-ph.GA
  • astro-ph.HE
  • astro-ph.IM
  • astro-ph.SR
  • cond-mat
  • cond-mat.dis-nn
  • cond-mat.mes-hall
  • cond-mat.mtrl-sci
  • cond-mat.other
  • cond-mat.quant-gas
  • cond-mat.soft
  • cond-mat.stat-mech
  • cond-mat.str-el
  • cond-mat.supr-con
  • cs
  • cs.AI
  • cs.AR
  • cs.CC
  • cs.CE
  • cs.CG
  • cs.CL
  • cs.CR
  • cs.CV
  • cs.CY
  • cs.DB
  • cs.DC
  • cs.DL
  • cs.DM
  • cs.DS
  • cs.ET
  • cs.FL
  • cs.GL
  • cs.GR
  • cs.GT
  • cs.HC
  • cs.IR
  • cs.IT
  • cs.LG
  • cs.LO
  • cs.MA
  • cs.MM
  • cs.MS
  • cs.NA
  • cs.NE
  • cs.NI
  • cs.OH
  • cs.OS
  • cs.PF
  • cs.PL
  • cs.RO
  • cs.SC
  • cs.SD
  • cs.SE
  • cs.SI
  • cs.SY
  • econ
  • econ.EM
  • eess
  • eess.AS
  • eess.IV
  • eess.SP
  • gr-qc
  • hep-ex
  • hep-lat
  • hep-ph
  • hep-th
  • math
  • math-ph
  • math.AC
  • math.AG
  • math.AP
  • math.AT
  • math.CA
  • math.CO
  • math.CT
  • math.CV
  • math.DG
  • math.DS
  • math.FA
  • math.GM
  • math.GN
  • math.GR
  • math.GT
  • math.HO
  • math.IT
  • math.KT
  • math.LO
  • math.MG
  • math.MP
  • math.NA
  • math.NT
  • math.OA
  • math.OC
  • math.PR
  • math.QA
  • math.RA
  • math.RT
  • math.SG
  • math.SP
  • math.ST
  • nlin
  • nlin.AO
  • nlin.CD
  • nlin.CG
  • nlin.PS
  • nlin.SI
  • nucl-ex
  • nucl-th
  • physics
  • physics.acc-ph
  • physics.ao-ph
  • physics.app-ph
  • physics.atm-clus
  • physics.atom-ph
  • physics.bio-ph
  • physics.chem-ph
  • physics.class-ph
  • physics.comp-ph
  • physics.data-an
  • physics.ed-ph
  • physics.flu-dyn
  • physics.gen-ph
  • physics.geo-ph
  • physics.hist-ph
  • physics.ins-det
  • physics.med-ph
  • physics.optics
  • physics.plasm-ph
  • physics.pop-ph
  • physics.soc-ph
  • physics.space-ph
  • q-bio
  • q-bio.BM
  • q-bio.CB
  • q-bio.GN
  • q-bio.MN
  • q-bio.NC
  • q-bio.OT
  • q-bio.PE
  • q-bio.QM
  • q-bio.SC
  • q-bio.TO
  • q-fin
  • q-fin.CP
  • q-fin.EC
  • q-fin.GN
  • q-fin.MF
  • q-fin.PM
  • q-fin.PR
  • q-fin.RM
  • q-fin.ST
  • q-fin.TR
  • quant-ph
  • stat
  • stat.AP
  • stat.CO
  • stat.ME
  • stat.ML
  • stat.OT
  • stat.TH
cnum
CNUM identifier of the conference

The CNUM is based on the starting day of the conference, with an extra number appended to distinguish conferences starting on the first day.

example:The first conference (in order of creation on Inspire) starting on December 25, 1987 has CNUM C87-12-25 whereas, say, the third one, has CNUM C87-12-25.2
type:string
pattern:^C\d\d-\d\d-\d\d(\.\d+)?$
contact

Contact person’s data

type:object

Properties: email, name

email

Contact person’s e-mail

type:string
format:email
name

Contact person’s name

type:string
country_code
ISO 3166-1 alpha 2 country code

Country code according to ISO 3166-1 alpha-2 with a few additions (CS - Czechoslovakia, YU - Yugoslavia, AB - Serbia and Montenegro, AN - Netherlands Antilles, NT - Neutral Zone)

type:string
maxLength:2
minLength:2

Allowed values:

  • AB
  • AF
  • AN
  • AX
  • AL
  • DZ
  • AS
  • AD
  • AO
  • AI
  • AQ
  • AG
  • AR
  • AM
  • AW
  • AU
  • AT
  • AZ
  • BS
  • BH
  • BD
  • BB
  • BY
  • BE
  • BZ
  • BJ
  • BM
  • BT
  • BO
  • BQ
  • BA
  • BW
  • BV
  • BR
  • IO
  • BN
  • BG
  • BF
  • BI
  • KH
  • CM
  • CA
  • CV
  • KY
  • CF
  • TD
  • CL
  • CN
  • CX
  • CC
  • CO
  • CS
  • KM
  • CG
  • CD
  • CK
  • CR
  • CI
  • HR
  • CU
  • CW
  • CY
  • CZ
  • DK
  • DJ
  • DM
  • DO
  • EC
  • EG
  • SV
  • GQ
  • ER
  • EE
  • ET
  • FK
  • FO
  • FJ
  • FI
  • FR
  • GF
  • PF
  • TF
  • GA
  • GM
  • GE
  • DE
  • GH
  • GI
  • GR
  • GL
  • GD
  • GP
  • GU
  • GT
  • GG
  • GN
  • GW
  • GY
  • HT
  • HM
  • VA
  • HN
  • HK
  • HU
  • IS
  • IN
  • ID
  • IR
  • IQ
  • IE
  • IM
  • IL
  • IT
  • JM
  • JP
  • JE
  • JO
  • KZ
  • KE
  • KI
  • KP
  • KR
  • KW
  • KG
  • LA
  • LV
  • LB
  • LS
  • LR
  • LY
  • LI
  • LT
  • LU
  • MO
  • MK
  • MG
  • MW
  • MY
  • MV
  • ML
  • MT
  • MH
  • MQ
  • MR
  • MU
  • YT
  • MX
  • FM
  • MD
  • MC
  • MN
  • ME
  • MS
  • MA
  • MZ
  • MM
  • NA
  • NR
  • NP
  • NL
  • NC
  • NT
  • NZ
  • NI
  • NE
  • NG
  • NU
  • NF
  • MP
  • NO
  • OM
  • PK
  • PW
  • PS
  • PA
  • PG
  • PY
  • PE
  • PH
  • PN
  • PL
  • PT
  • PR
  • QA
  • RE
  • RO
  • RU
  • RW
  • BL
  • SH
  • KN
  • LC
  • MF
  • PM
  • VC
  • WS
  • SM
  • ST
  • SA
  • SN
  • RS
  • SC
  • SL
  • SG
  • SX
  • SK
  • SI
  • SB
  • SO
  • ZA
  • GS
  • SS
  • ES
  • LK
  • SD
  • SR
  • SJ
  • SU
  • SZ
  • SE
  • CH
  • SY
  • TW
  • TJ
  • TZ
  • TH
  • TL
  • TG
  • TK
  • TO
  • TT
  • TN
  • TR
  • TM
  • TC
  • TV
  • UG
  • UA
  • AE
  • GB
  • US
  • UM
  • UY
  • UZ
  • VU
  • VE
  • VN
  • VG
  • VI
  • WF
  • EH
  • YE
  • YU
  • ZM
  • ZW
degree_type
Academic degree type

The other value means that the degree type is not known or is not among the more specific values.

type:string

Allowed values:

  • other
  • diploma
  • bachelor
  • laurea
  • master
  • phd
  • habilitation
document_type
type:string
default:article

Allowed values:

  • activity report
  • article
  • book
  • book chapter
  • conference paper
  • note
  • proceedings
  • report
  • thesis
id

May satisfy any of the following definitions:

CERN institutional ID

Also called CCID (e.g. on legacy).

type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • CERN
value
example:CERN-12345
type:string
pattern:^CERN-\d+$
DESY identifier
type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • DESY
value
example:DESY-15456
type:string
pattern:^DESY-\d+$
Google Scholar profile identifier
type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • GOOGLESCHOLAR
value
example:AZUAeayXuibs
type:string
pattern:^(\w|-){12}$
Inspire BAI

The BAI (BibAuthorID) is based on the name of the author and is used as a human-friendly unique identifier. Its general form is a firstnames.lastnames.number, where firstnames is a list of first names (or initials) separated by dots, and similarly for lastnames. Only ASCII letters (without diacritics), numbers, dashes and apostrophes are allowed in the names. By default, only initials of first names are used, but this may be changed at a cataloguer’s discretion in order to disambiguate otherwise homonymous authors.

Note

This identifier is not persistent, as it can be renamed to become more explicit (e.g. transforming an initial into a full name), or disappear when merging two different authors.

type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • INSPIRE BAI
value
example:A.Einstein.1
type:string
pattern:^((\w|\-|\')+\.)+\d+$
Inspire ID

This identifier is assigned to any curated author record (HEPNAMES on legacy). It is mainly used by large collaborations (providing an authors.xml file) to uniquely identify the authors of their articles.

type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • INSPIRE ID
value
example:INSPIRE-12345678
type:string
pattern:^INSPIRE-\d{8}$
JACoW ID

Author identfier assigned by the Joint Accelerator Conferences Website (JACoW).

type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • JACOW
value
example:JACOW-12345678
type:string
pattern:^JACoW-\d{8}$
KAKEN ID

Author identifier assigned by the Japanese KAKEN grants database.

type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • KAKEN
value
example:KAKEN-12345678
type:string
pattern:^KAKEN-\d{8}$
ORCID

ORCID provides an identifier for individuals to use with their name as they engage in research, scholarship, and innovation activities.

The ORCID identifier can be resolved by prepending http://orcid.org to the value, in order to get the ORCID record of the person.

type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • ORCID
value
example:0000-0012-1234-5647
type:string
pattern:^\d{4}-\d{4}-\d{4}-\d{3}[0-9X]$
ResearcherID
type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • RESEARCHERID
value
example:A-1009-2008
type:string
pattern:^[A-z]-\d{4}-\d{4}$
SCOPUS author identifier
type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • SCOPUS
value
example:13245678901
type:string
pattern:^\d{10, 11}$
SLAC identifier
type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • SLAC
value
example:SLAC-123456
type:string
pattern:^SLAC-\d+$
SPIRES HEPNAMES ID

HEPNAMES entry in the old SPIRES system.

type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • SPIRES
value
example:HEPNAMES-123456
type:string
pattern:^HEPNAMES-\d+$
VIAF record ID

Record ID in the Virtual International Authority File (VIAF).

type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • VIAF
value
example:75121530
type:string
pattern:^\d{7, 9}$
Wikipedia Page_name of the person
type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • WIKIPEDIA
value

A page name on the English Wikipedia, i.e. the Page_name part in http://en.wikipedia.org/wiki/Page_name.

example:Albert_Einstein

Non-English Wikipedia pages can be referenced by prepending the language.

example:it:Fabiola_Gianotti
type:string
arXiv author identifier

More info at arXiv.

type:object
Required:schema, value

Properties: schema, value

schema
type:string

Allowed values:

  • ARXIV
value
example:warner_s_1
type:string
pattern:^\w+_(\w_)?\d+$
inspire_field
Inspire category
MARC:65017 with 2:INSPIRE

The Inspire category (also called field category) classifies the subject this record is related to. This classification schema is similar to the arXiv one (see elements/arxiv_categories.json) and there is a way to map from arXiv categories to Inspire categories.

type:object

Properties: source, term

source
type:string

Allowed values:

  • curator
  • magpie
  • arxiv
  • user
  • undefined
term
type:string

Allowed values:

  • Accelerators
  • Astrophysics
  • Computing
  • Data Analysis and Statistics
  • Experiment-HEP
  • Experiment-Nucl
  • General Physics
  • Gravitation and Cosmology
  • Instrumentation
  • Lattice
  • Math and Math Physics
  • Other
  • Phenomenology-HEP
  • Theory-HEP
  • Theory-Nucl
json_reference
Reference to another record
type:object
Required:$ref

Properties: $ref

$ref

URL to the referenced resource

type:string
format:url
language_code
ISO 639-1 alpha 2 language code

Language code according to ISO 639-1.

example:el for Greek.
type:string
maxLength:2
minLength:2

Allowed values:

  • aa
  • ab
  • af
  • ak
  • am
  • ar
  • an
  • as
  • av
  • ae
  • ay
  • az
  • ba
  • bm
  • be
  • bn
  • bi
  • bo
  • bs
  • br
  • bg
  • ca
  • cs
  • ch
  • ce
  • cu
  • cv
  • kw
  • co
  • cr
  • cy
  • da
  • de
  • dv
  • dz
  • el
  • en
  • eo
  • et
  • eu
  • ee
  • fo
  • fa
  • fj
  • fi
  • fr
  • fy
  • ff
  • gd
  • ga
  • gl
  • gv
  • gn
  • gu
  • ht
  • ha
  • sh
  • he
  • hz
  • hi
  • ho
  • hr
  • hu
  • hy
  • ig
  • io
  • ii
  • iu
  • ie
  • ia
  • id
  • ik
  • is
  • it
  • jv
  • ja
  • kl
  • kn
  • ks
  • ka
  • kr
  • kk
  • km
  • ki
  • rw
  • ky
  • kv
  • kg
  • ko
  • kj
  • ku
  • lo
  • la
  • lv
  • li
  • ln
  • lt
  • lb
  • lu
  • lg
  • mh
  • ml
  • mr
  • mk
  • mg
  • mt
  • mn
  • mi
  • ms
  • my
  • na
  • nv
  • nr
  • nd
  • ng
  • ne
  • nl
  • nn
  • nb
  • no
  • ny
  • oc
  • oj
  • or
  • om
  • os
  • pa
  • pi
  • pl
  • pt
  • ps
  • qu
  • rm
  • ro
  • rn
  • ru
  • sg
  • sa
  • si
  • sk
  • sl
  • se
  • sm
  • sn
  • sd
  • so
  • st
  • es
  • sq
  • sc
  • sr
  • ss
  • su
  • sw
  • sv
  • ty
  • ta
  • tt
  • te
  • tg
  • tl
  • th
  • ti
  • to
  • tn
  • ts
  • tk
  • tr
  • tw
  • ug
  • uk
  • ur
  • uz
  • ve
  • vi
  • vo
  • wa
  • wo
  • xh
  • yi
  • yo
  • za
  • zh
  • zu
material
Material to which the field refers

The possible values are:

addendum
for a document extending the main publication.
erratum
for a document correcting errors in the content of the main publication. When the errors are not in the content but in the publication process, it is considered as an editorial note instead.
editorial note
for a document correcting errors in the metadata of the publication but not its content. Otherwise, it is an erratum.
preprint
for a document that is made public (typically on arXiv) but not yet published formally.
publication
for the main publication. If it’s not published, it’s a preprint.
reprint
for a reprint of the main publication.
translation
for a translation of the main publication.
type:string

Allowed values:

  • addendum
  • erratum
  • editorial note
  • preprint
  • publication
  • reprint
  • translation
rank
Rank of academic position
type:string

Allowed values:

  • STAFF
  • SENIOR
  • JUNIOR
  • VISITOR
  • POSTDOC
  • PHD
  • MASTER
  • UNDERGRADUATE
  • OTHER
records-files
File schema.

Describe information needed for files in records.

type:object

Properties: bucket, checksum, key, size, version_id

bucket
type:string
checksum
type:string
key
type:string
size
type:integer
version_id
type:string
reference
A reference to a cited document

This is structurally very similar to a Literature record, with unnecessary fields removed. For more information about the meaning of the different fields, see the corresponding field in hep.

type:object

Properties: arxiv_eprint, authors, book_series, collaborations, document_type, dois, imprint, isbn, label, misc, persistent_identifiers, publication_info, report_numbers, texkey, title, urls

arxiv_eprint
arXiv eprint number
MARC:999C5r with arXiv: prefix
example:1703.07274
type:string
pattern:^\d{4}.\d{4, 5}|[\w.]+(-[\w.]+)?/\d+$
authors
List of authors
MARC:999C5h contains a comma-separated string with all authors, in first_name last_name order.
type:array
Every element of authors is:
type:object

Properties: full_name, inspire_role

full_name

Should be of the same form as full_name.

example:Smith, John G.D.
type:string
inspire_role
MARC:999C5e for editor
type:string

Allowed values:

  • author
  • supervisor
  • editor
book_series
type:object

Properties: title, volume

title
type:string
volume
type:string
collaborations
type:array
Every element of collaborations is:
MARC:999C5c
type:string
document_type
MARC:conceptually similar to 999C5d, but allowed values differ.
Reference:document_type
dois
type:array
Every element of dois is:
MARC:999C5a with prefix doi:
type:string
pattern:^10\.\d+(\.\d+)?/.+$
imprint
type:object

Properties: date, place, publisher

date
type:string
format:date
place
type:string
publisher
MARC:999C5p
type:string
isbn
MARC:999C5i

ISBN if the cited document is a book.

Note

If the cited document is a book chapter, use parent_isbn instead.

type:string
pattern:^\d*[0-9X]$
label
MARC:999C5o

Label used to refer to the reference in the main text, and put in front of the reference in the reference list. Often, this is a number, found in square brackets. These brackets (or parentheses), if present, should not be put here.

example:42
example:Jones1995c
type:string
misc
MARC:999C5m

Unrecognized information from the reference.

type:array
Every element of misc is:
type:string
persistent_identifiers
MARC:999C5a (with prefix hdl: or urn:)
type:array
Every element of persistent_identifiers is:
type:object

Properties: schema, value

schema
type:string

Allowed values:

  • HDL
  • URN
value
type:string
publication_info
type:object

Properties: artid, cnum, journal_issue, journal_title, journal_volume, material, page_end, page_start, parent_isbn, parent_report_number, parent_title, year

artid
MARC:last part of 999C5s (if not a page)
type:string
cnum
MARC:999C5b
Reference:cnum
journal_issue
MARC:999C5n
type:string
journal_title
MARC:first part of 999C5s
type:string
journal_volume
MARC:second part of 999C5s
type:string
material
Reference:material
page_end
MARC:Last part of 999C5s (if page-range)
type:string
page_start
MARC:Last part of 999C5s (if not article ID)
type:string
parent_isbn
MARC:999C5i, but not distinguished from the isbn of the cited document.

If the cited document is a book chapter, this is the ISBN of the book.

type:string
pattern:^\d*[0-9X]$
parent_report_number
MARC:999C5r but not distinguished from the cited document report_numbers.
type:string
parent_title
MARC:999C5q

Title of the parent document, e.g. title of the book if the cited document is a book chapter.

type:string
year
MARC:999C5y
type:integer
minimum:1000
maximum:2050
report_numbers
MARC:999C5r

Note

If the cited document is only part of a report, use parent_report_number instead.

type:array
Every element of report_numbers is:
type:string
texkey
MARC:999C5k

Key that was used for this citation in the document. This may be extracted if the document is a PDF generated from a LaTeX, and possibly coincides with the one of the texkeys assigned to the cited document by Inspire and made visible in the TeX export formats.

example:Maldacena:1997re
type:string
title
Reference:title
MARC:999C5t
urls
type:array
Every element of urls is:
MARC:999C5u
Reference:url
source

Source of the information in this field. As several records can be merged, this information allows us to remember where every bit of metadata came from and make decisions based on it.

MARC:Often not present.
type:string
sourced_value

This is used to add, besides the value, the source where this value came from.

type:object
Required:value

Properties: source, value

source
Reference:source
value
type:string
title
type:object

Properties: source, subtitle, title

source
type:string
subtitle
type:string
title
type:string
url
URL of related document
MARC:8564
type:object

Properties: description, value

description
MARC:8654__y
type:string
value
MARC:8564_u
type:string
format:url

Additional Notes

Notes on how to contribute, legal information and changes are here for the interested.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

Report Bugs

Report bugs at https://github.com/inspirehep/inspire-schemas/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.
Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

inspire-schemas could always use more documentation, whether as part of the official inspire-schemas docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/inspirehep/inspire-schemas/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up inspire-schemas for local development.

  1. Fork the invenio repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/inspire-schemas.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv inspire-schemas
$ cd inspire-schemas/
$ pip install -e .[all]

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass tests:

    $ ./run-tests.sh

    The tests will provide you with test coverage and also check PEP8 (code style), PEP257 (documentation), flake8 as well as build the Sphinx documentation and run doctests.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -s \
    -m "component: title" \
    -m "* Adds your new feature." \
    -m "* Fixes an existing issue." \
    -m "* Improves and existing feature." \
    -m "" \
    -m "Sem-Ver: new feature" \
    -m "Sem-Ver: breaks api"
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests and must not decrease test coverage.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring.
  3. The pull request should work for all the currently supported Python vesions, as of writing that is 2.7, and 3.5. Check https://travis-ci.org/inspirehep/inspire-schemas/pull_requests and make sure that the tests pass for all supported Python versions.

License

Inspire-schemas is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Inspire-schemas is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Inspire-schemas; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an Intergovernmental Organization or submit itself to any jurisdiction.

Changelog

Here you can find the full changelog for this version