dysh Documentation

dysh is a Python spectral line data reduction and analysis program for singledish data with specific emphasis on data from the Green Bank Telescope. It is currently under development in collaboration between the Green Bank Observatory and the Laboratory for Millimeter-Wave Astronomy (LMA) at the University of Maryland (UMD). It is intended to be an alternative for GBTIDL, GBO’s current spectral line data reduction package.

Contents

• Background
  • Context Within GBO Systems
    • Background
    • Requirements
  • SDFITS Files
    • GBT SDFITS Files
• Getting Started
  • Installing dysh
    • With pip from PyPi
    • From github
  • Tutorials
    • Tutorials for GBT Data
• Examples for GBT Data
  • Position-Switched Data
    • Background
    • Calibrating Position-Switched Data
    • Removing a baseline
  • Total Power Data
    • Retrieving and Viewing a Total Power Scan
  • SubBeamNod
    • Calibrating SubBeamNod Data
• Modules and APIs
  • Reading in and writing out observations
    • Loading SDFITS files
    • SDFITSLoad
    • GBTFITSLoad
  • Spectral classes and functions
    • Core Functions
    • Spectrum
    • Scan
  • Plotting classes and functions
    • SpecPlot
  • Utility classes and functions
    • Selection
    • consecutive()
    • gbt_timestamp_to_time()
    • generate_tag()
    • get_project_root()
    • get_project_testdata()
    • get_size()
    • keycase()
    • minimum_string_match()
    • select_from()
    • sq_weighted_avg()
    • stripTable()
    • uniq()
• For Beta Testers
  • Instructions for Beta Testers
    • Providing feedback
    • Installing dysh
• For Developers
  • Contributing
  • Installation for Developers
    • Additional Installation Options
    • Sample workflows
  • Documentation
    • Setting Up Sphinx Autobuilds
    • Docstring Format
    • Mermaid Diagrams
  • GitHub Integrations
    • Actions
    • Issues
    • Pre-Commit Hooks
    • Projects
  • Git Workflows
    • Branches
    • Releases
    • Setting up your own development branch
  • Steps for publishing a new dysh release
  • Black Formatting
    • VSCode
  • Terminal Messages
    • Dysh Rich Console
    • Friendly Messages
    • System Messages
• Performance Testing
  • Performance vs. GBTIDL
• Design
  • SDFITS Loaders
    • Motivation
    • ScanBlock
    • SDFITSLoad
    • GBTFITSLoad
  • Structure

Indices and tables

• Index

• Module Index

• Search Page

Reporting Issues

If you find a bug or something you think is in error, please report it on the GitHub issue tracker. You must have a GitHub account to submit an issue.

Credits

dysh is being developed by a partnership between the Green Bank Observatory and the Laboratory for Millimeter-wave Astronomy at the University of Maryland, College Park.

Dev Team

Marc Pound (UMD)

Victoria Catlett (GBO)

Peter Teuben (UMD)

Pedro Salas (GBO)

Evan Smith (GBO)

Thomas Chamberlain (GBO)