almanac

almanac scrapes headers from raw image files and cross-matches those against the SDSS database to create a comprehensive summary of everything ever observed with an APOGEE instrument.

Quick Start

# Install almanac
uv pip install git+https://github.com/sdss/almanac

# Query yesterday's observations
almanac --mjd -1 -vv

# Query with fiber mappings
almanac --mjd -1 --fibers --output results.h5

Table of Contents

User Guide

• Installation Guide
  • Requirements
  • Installation Methods
  • Post-Installation Setup
  • Dependencies
  • Troubleshooting
• User Guide
  • Overview
  • Basic Usage
  • Date and Time Queries
  • Fiber Mapping Analysis
  • Output and Verbosity
  • Advanced Features
  • Data Structure Examples
  • Common Workflows
  • Tips and Best Practices
  • Next Steps
• CLI Reference
  • Main Command
  • Global Options
  • Configuration Commands
  • Usage Examples
  • Advanced Usage Patterns
  • Exit Codes
  • Environment Variables
  • Shell Completion
  • Tips
• Configuration Guide
  • Configuration Overview
  • Configuration File
  • Configuration Reference
  • Configuration File Format
  • Environment-Specific Configuration
  • Configuration Management
  • Command-Line Overrides
  • Troubleshooting Configuration
  • Advanced Configuration
  • Configuration Schema
• Data Formats
  • Data Model Architecture
  • Exposure Model
  • FPSTarget Model
  • PlateTarget Model
  • Type Definitions
  • Data Validation and Processing
  • HDF5 Output Structure
  • Data Quality and Validation
• Frequently Asked Questions
  • Installation and Setup
  • Database Connection Issues
  • Data and File Access
  • Usage and Commands
  • Data Interpretation
  • Performance and Optimization
  • Configuration Issues
  • Error Messages
  • Data Quality and Validation
  • Getting Help

Developer Guide

• API Reference
  • Module Structure
  • almanac.config
  • almanac.database
  • almanac.apogee
  • almanac.io
  • almanac.cli
  • almanac.display
  • almanac.logger
  • almanac.utils
  • Data Types and Structures
  • Error Handling
• Development Guide
  • Development Setup
  • Project Structure
  • Development Workflow
  • Testing
  • Contributing
  • Building and Distribution
  • Documentation
  • Debugging
  • Continuous Integration
  • Security
  • Performance Considerations
  • Getting Help

API Documentation

• almanac

Installation

At Utah

module load almanac

Anywhere else

uv add sdss-almanac

Basic Usage

Query today’s observations:

almanac

Query with details:

almanac -vv --mjd -1

Query with fiber mappings:

almanac --mjd 60000 --fibers

Save to file:

almanac --output results.h5 --mjd-start -7

Key Features

• Cross-platform: Works at Utah and external installations

• Flexible queries: Support for MJD and calendar date ranges

• Fiber analysis: Complete fiber-to-target mapping analysis

• Structured output: HDF5 files with organized data structure

• Observatory support: Both Apache Point Observatory and Las Campanas Observatory

• Database integration: Automatic cross-matching with SDSS database

• Performance optimized: Parallel processing and efficient data handling

Observatory Coverage

• Apache Point Observatory (APO): New Mexico, USA

• Las Campanas Observatory (LCO): Chile

Survey Support

• SDSS-IV: Plate-based observations with APOGEE-2

• SDSS-V: Fiber positioner system (FPS) with updated APOGEE

Indices and Tables

• Index

• Module Index

• Search Page