IpTool User Manual

• Introduction
  • Scope
  • What IpTool is
  • What IpTool gives you
  • Who should read this manual
  • Acronyms
  • Glossary
• Overview
  • The Instrument Package (IP)
    • Role in the operations pipeline
    • IP artefacts (defined by the OTTO IP schemata)
    • Artefacts that are not part of the IP
    • How the IP is used
  • The CII Config Service
  • Goals
  • Authoring model
  • Output tree
• Schema
  • Top-level typed instances
  • Conventions
    • snake_case vs. camelCase
    • Parameter names (/ in YAML, . in OTTO)
  • The lifecycle of one parameter
    • Author view (include/det.keys.ipt.yaml)
    • What the compiler emits (templates/tstins_img_cal_bias.json)
    • What OTTO requires of it
    • Per-template override with !cfg.merge
    • Failure modes mapped to where each is caught
    • Typed initial_value and domain
    • Per-type value constraints in OTTO
• CLI
  • Quickstart
  • ifwIpToolCompiler
  • ifwIpToolValidator
• Examples
  • Parameter library (keys)
  • Non-P1 calib template
  • P1 acquisition template
  • P1 science template (full type coverage)
  • IP-wide metadata
  • Compile it
  • A second, minimal example: TSTNLS (no laser)
  • Real-world example: FORS3 IPT
    • What it covers
    • Library organisation: one file per FITS prefix
    • Per-template overrides: !cfg.merge discipline
    • Type-changing !cfg.merge (advanced)
    • Portable ipt/ layout
    • Compile performance
    • How to start your own instrument project
• Tutorial
  • Bootstrap a new instrument
  • Author a parameter (one recipe per type)
    • Integer with an interval domain
    • Integer with a discrete domain
    • Number with an interval domain (C3 worked example)
    • String (free text)
    • Keyword (controlled vocabulary)
    • Boolean
    • RA / Dec
    • Lists (intlist / numlist / keywordlist)
    • Target reference (targetref / targetreflist)
    • Binary / text file uploads
  • Author a template
  • Per-template overrides with !cfg.merge
  • When the validator complains

Indices and tables

• Index

• Search Page