ALBATROS Analysis

Welcome to the ALBATROS pipeline documentation site. The idea behind these pages are to give as much depth and breadth of knowledge as is needed to both use and understand the code written for the ALBATROS project. This site is split into four main sections:

Pipeline

The Pipeline Pages give a detailed overview and explanation of each component of the code. This is best for newcomers who want to understand what is happening as a whole, or for people who want some reasoning as to why specific design choices were made.

API (Source Code)

The API Pages constitute formal API documentation on all the helper and utility functions that were made for this project. This is useful for quick lookups, or to understand what each function actually does. For people who want to expand on/develop the project, the API documentation will give you many tools to do so. This code is importable as a package.

Tutorials (Science Code)

The Tutorials give runthroughs and explanations of each main workflow that is used in this pipeline. It serves as a good reference for getting started on writing your own scripts.

Testing

This section is split into Science Tests which aims to validate physical results, and Software Tests which aim to validate computation techniques and data processing. Testing is mainly present for analysts using the pipeline who wish to verify their code and document the results.