Skip to content

Latest commit

 

History

History
executable file
·
29 lines (22 loc) · 1.95 KB

InternalModel.md

File metadata and controls

executable file
·
29 lines (22 loc) · 1.95 KB

Internal Model for FacilityList

The list-parsing functions are defined in conf/parsers.py. Each function should return a dictionary following the specification described below.

The dictionary is composed of pairs of (key, value) defined as follows:

  • key is composed of a short authority name acting as a name space (e.g., aas for the AAS list), followed by an ID derived from the current list, joined with a :, for instance: aas:SORCE.
  • value is a dictionnary object comforing with the models/facility.json JSON schema.

Individual Facility elements

The Observatory descriptor follows the model described in the models/facility.json JSON schema.

The expected properties are:

  • alternateName: (list) A list of all alternate names dictionaries (see below)
  • facilityType: (str) A string containing either spacecraftor observatory
  • location: (dict) A dictionary containing continent, country, place and/or coordinates. The coordinates property is a dictionary with lat (latitude), lon (longitude), alt (altitude), sin (ρ sin(φ) parallax coordinate), cos (ρ cos(φ) parallax coordinate) and/or tz (time zone) properties.
  • measurementType: (list) A list of string items (following IVOA UCD specification).
  • targetList: (list) A list of string items with target names.
  • facilityGroup: (str) A named group to which the Facility belongs to.
  • instrumentList: (list) A list of string items with instrument names.
  • referenceURL: (str) A list of string items containing URL to a reference website(s) or documentation.
  • launchDate: (str) A string containing the launch date for a spacecraft.

Each alternateName object contins the following attributes:

  • namingAuthority: (str) a naming authority
  • name: (str) a name for the Facility
  • id: (str) an ID for the Facility

Note the name and id are considered as alternate names of the same Facility.