GPI Data Pipeline Developer’s Guide

This document describes the internal workings of the GPI pipeline, and provides information on how to maintain, modify, and enhance it. It also tells you how to improve this documentation.

Warning

Compared to the other GPI pipeline docs, this is currently pretty rough - please treat this document as a work in progress!

This document assumes readers are already familiar with the content in the Installation & Configuration and User’s Guide sections.

See the development credits page for a list of GPI instrument team and Gemini staff members who have contributed to this project.

Contents

• Introduction for New Developers
  • Best Steps for Getting Started
  • Subversion Repository Organization
  • Terminology
• Pipeline Code Internal Organization
  • Major software components and object classes
  • Function Call Hierarchy when Running Recipes
  • Common Blocks
• Calibration Database
  • Rules for Matching Files
• Utility Functions
  • Pipeline Configuration Settings
  • Data Paths and Filenames
  • FITS Files and Header Keywords
• Primitives
  • Adding New Primitives
  • Indicating Progress for Long-Running Primitives
• GPItv Development
  • Overview
  • Design Principles and Dependencies
  • Value Storage
  • Image Storage
  • Satellite Spots and Contour Profiles
  • Collapse Modes
  • Scaling
  • Message Output
  • The call sequence for loading new images in GPItv
  • GPItv Subwindows and Event Handlers
• Editing Documentation (Including this Website)
  • Quickstart
  • Some Sphinx Syntax Tips
  • Installing Sphinx
  • Building the docs
  • Documenting Primitives
• Release Guide: Versions, Version Tracking, etc
  • Branches
  • Creating a New Release Version
  • Switching to a given release on subversion
• Appendix: Recipe XML File (‘DRF’) Format
  • Recipe DRF XML tags
  • Common parameters
  • Example DRF
• Appendix: Primitives Configuration XML File Format and Generation
• Credits for the GPI Pipeline Software Development
  • The GPI Data Analysis Team
  • Other Acknowledgements