wiki:add_type_form

Adding New Reference Types Required Information

Overview

This page describes information required to add a new reference type to CRDS. Please fill out and submit the attached form as part of a new reference type request, citing any related ticket(s). Supplied information generally falls into 3 categories:

  1. Basic naming properties for files and the CRDS web site.
  2. Best reference file selection parameter names, and/or definitions of when the type is assumed to be N/A.
  3. Critical parameter and file properties that ideally should be checked by crds.certify.

Adding new types involves adding specification code to the CRDS client s/w in addition to creating the initial rmap(s) so type addition is generally tied to the pipeline release cycle and formal CRDS releases. This considerably extends the lead time required to deploy new types without special releases so where possible please request new types as early as possible, ideally 6 months before pipeline installation and operability is required.

Basic Information

Jira / TRAC TICKET # (https://jira.stsci.edu/browse/CRDS)


FILE DESCRIPTION (For rmap and web submission)


PROJECT/OBSERVATORY (HST, JWST, ...)


INSTRUMENT (e.g. MIRI, ACS, ...)


TYPE NAME (CRDS filekind, no underscores, letter first, e.g. 'flat', 'extract1d')


LONG FORM TYPENAME (for website context display, e.g. '1-D Spectral Extraction')


EXTENSION / FILE FORMAT (.asdf, .fits, .json)


SELECTION PARAMETER NAMES


REQUIRED (YES / NO?)


INITIAL REFERENCE PATH


INTIAL REFERENCE FILENAMES


PERSON REQUESTING NEW REFERENCE TYPE


TABLE (YES / NO?)


CORRECTION KEYWORD NAME (eg. HST CORR keyword?)


Advanced / Optional Information

CRITICAL PARAMETER CONSTRAINTS (Invariant for format, header parameters)


EXPRESSION DEFINING N/A (rmap_relevance expression, OPTIONAL)


SPECIFIC PARAMETER VALUES WHERE TYPE IS N/A (rmap match cases)


VALUE SUBSTITUIONS (e.g. GENERIC --> N/A, reference + displays as GENERIC, matches as N/A, OPTIONAL)


REFERENCE TO DATASET SUBSTITIONS (reference parameter name : data model parameter name, OPTIONAL)


CONTIONAL VALUE SUBSTITUTIONS (e.g. WFC3 APERTURE group translations, rmap update time, OPTIONAL)


UNIQUE ROW COLUMN NAMES (for table difference checking, OPTIONAL, tables)


TABLE ROW LOOKUP COLUMN NAMES (for reprocessing optimization, row duplicate and table mode deletion checking)


TABLE ROW LOOKUP ALGORITHM (for reprocessing optimization, OPTIONAL, tables)


Last modified 23 months ago Last modified on 02/03/17 13:02:36

Attachments (1)

Download all attachments as: .zip