Instrument Handbook

Welcome to the MagAO-X Instrument Handbook.

Table of contents

• Information For Observers
  • Instrument Use Policy
    • Introduction
    • Collaborations
    • Proposals
    • The H-alpha Proto-Planet Survey
    • Nearby Bright Stars
    • Laboratory Experiments
  • Planning your observations
    • Filters and Throughputs
    • Camera Characteristics
    • Coronagraphs
  • Data reduction and calibration
    • Sky orientation & pixel scale
  • Data Policy
    • Laboratory and Engineering Data
    • Science Observations
    • Policies and provision for re-use, re-distribution and products of derivatives
    • Archiving of Data
    • Documentation
  • Accessing data as a guest observer
    • Preliminaries
    • Connecting
    • Browsing the data
    • Downloading science data
• Operation of the MagAO-X instrument
  • System Startup
    • System Powerup
    • Software Startup
    • GUI Setup
  • CACAO Setup
    • Terminal Interface Setup
    • Graphical User Interface
    • High-order Loop
    • Low-order T/T Loop
  • Daily Startup
  • Alignment
    • System Pupil Alignment
    • Coronagraph Alignment
    • Focus Diversity Phase Retrieval (FDPR)
  • Daily Shutdown
    • Lunch Break
    • Minimal shutdown
    • Standard Daily Shutdown
  • System Shutdown
    • ICC and RTC Shutdown
    • Total Shutdown (for packing, etc.)
    • AOC Shutdown
  • Telemetry and Data Dashboard
    • Usage
  • Running MagAO-X from your own computer
    • Running MagAO-X from macOS
    • Running MagAO-X from Linux
    • Running MagAO-X from Windows
  • Creating a new MagAO-X app with Python
    • Creating the app
    • Defining configurable properties
    • Tell the build system about your app
    • Plumbing the device processs into MagAO-X
    • Starting your device
    • Hacking on your device
    • Logging to console and disk
  • GUIs & TUIs
    • cursesINDI
    • Web GUI
    • Cameras
  • Utilities
    • xctrl
    • lookyloo
    • logdump
    • getINDI
    • setINDI
    • evalINDI
    • indiserver
    • The Eye Doctor
    • Focus Diversity Phase Retrieval (and correction)
    • Shared Memory Transfer
  • Applications
    • Overview
    • Cameras
    • Deformable mirrors
    • Stages and filter wheels
    • Networking
    • Power control devices
• Testbed Operation
  • General Safety
  • General Troubleshooting
  • Remote operation with a virtual machine (VM)
    • Initial Setup
    • Updating the VM
    • Startup
  • VM Commands
    • pwrGUI
    • rtimv
    • roiGUI
    • dmCtrlGUI
    • dmModeGUI
  • Commands run on exao0
    • Startup and shutdown with xctrl
    • Humidity Sensing
    • cursesINDI
    • The Eye Doctor for CACTI
  • Running Python to control exao0
    • Running Jupyter Notebook (Python)
    • Saving Camera Images with magpyx
    • Applying DM commands with magpyx
• Maintenance of the MagAO-X instrument
  • Liquid Cooling
    • Maintenance
• Troubleshooting
  • Figuring out what exactly isn’t working
  • Addressing specific issues
    • Shared memory image problems with “No space left on device” errors
    • Loop failing to close for no apparent reason and/or intermittent failures of CACAO calibration process
    • Lockup / Missing GPUs / nvidia-smi errors
    • OCAM connectivity / bad data
    • Alpao DM not responding
    • DM Latency and Communication Troubleshooting
    • EDT Framegrabber Problems (camwfs)
    • Camsci1/2 not responding
    • Killing INDI zombies
    • Difficulties with NVIDIA proprietary drivers
    • Computer Fails to Boot
    • USB Device Communication Problems
• Handling Procedures
• Compute System
  • Python environments
    • Adding a package
    • Updating conda
    • Performing a fresh conda install/upgrade
  • Telemetry and File Inventory Database
    • Maintenance
    • Setup
    • Setup a personal copy of the database
  • System Maintenance & Administration
    • Adding a new user or developer account
    • Configuring git for a new user account
    • Upgrading NVIDIA CUDA and drivers
    • Upgrading the RT kernel
  • Networking
    • Topology
    • Ubuntu and NetworkManager and ufw and firewalld
    • Firewall zones
    • Network Connections
    • Hostnames
    • Time synchronization
  • Data Storage Management
    • Using the file inventory database to synchronize backups
    • RAID arrays
  • Instrument computer setup guide
    • BIOS
    • OS Installation
    • After OS installation
    • Configure /data array options
    • Setup ssh
    • Setup network attached storage (NAS)
    • AOC only: GPU drivers setup
    • Perform (mostly) automated provisioning
    • Perform xsup key management
    • Verify bootloader installation / RAID correctness
  • Migrating data from an existing installation
  • Installing MagAO-X on a Raspberry Pi
    • Configuring the Raspberry Pi
    • Install MagAO-X
  • SSL Certificates
    • Brand-new certificates
    • Renew certificates
    • Installing certificates for sup
  • Network Attached Storage
    • Using the Steward NAS
    • Connecting your own computer to the Steward NAS
    • Connecting a server to the Steward NAS
  • Instrument Virtual Private Network
    • On first connection
    • Making use of the VPN
  • Computer Architecture
    • Real Time Controller
    • Instrument Control Computer
• Appendices
  • Glossary of terms
  • Documenting MagAO-X
    • Where the documentation lives
    • How to make changes: in brief (e.g. for typo corrections)
    • How to make bigger changes
    • Markup
  • Preliminary design review
    • Table of Contents
    • Appendix
  • Pre-ship Review
    • Table of Contents

Resources

• API Reference Manual

• magao-x/MagAOX on GitHub