Welcome to the Gamma-ray Data Tools Core Package!

The Gamma-ray Data Tools (GDT) is centralized toolkit for hard X-ray and gamma-ray astrophysics data analysis, with a focus on providing a uniform interface to the data provided by several different missions and instruments.

The GDT Core Package (gdt-core) contains the core components of the GDT that can be utilized for various instruments and is a generalized version of the Fermi GBM Data Tools. Individual mission or instrument packages can be developed using the gdt-core and released under the gdt namespace (see gdt-fermi as an example).

The documentation linked below walks through all of sub-packages and modules within the gdt-core, and developers should take special note of the “For Developers” sections that detail how to subclass or design plugin functions or classes for use in new instrument packages.

GDT Mission Packages

The following mission packages are currently part of the GDT family:

• gdt-cgro (BATSE)

• gdt-fermi (GBM)

• gdt-hete2 (FREGATE)

• gdt-integral (SPI-ACS)

• gdt-maxi (GSC)

• gdt-rxte (ASM)

• gdt-swift (BAT)

Citing

If you use the GDT Core package to develop your own mission our instrument package, we would appreciate an appropriate acknowledgment. For publications, we suggest the following BibTex:

@misc{GDT-Core,
      author = {Adam Goldstein and William H. Cleveland and Daniel Kocevski},
      title = {Gamma-ray Data Tools Core Package: v2.0.4},
      year = 2024,
      url = {https://github.com/USRA-STI/gdt-core}
}

Acknowledgments

The Gamma-ray Data Tools are partially funded through the NASA ADAP Grant 80NSSC21K0651 and the NASA SMD Open Source Tools, Frameworks, and Libraries Grant 80NSSC22K1741.

Getting Started

• Installation

User Documentation

Data Types and Utilities

• Data Primitives (gdt.core.data_primitives)
• Data Collections (gdt.core.collection)
• The HealPix Module (gdt.core.healpix)
• PHA (Pulse Height Amplitude) Files (gdt.core.pha)
• PHAII Files (gdt.core.phaii)
• Instrument Responses (gdt.core.response)
• Photon List and Time-Tagged Event Files (gdt.core.tte)

File Access and Definitions

• The File Module (gdt.core.file)
• Data File Headers (gdt.core.headers)

Mission and Instrument Definitions

• Spacecraft Attitude, Position, and Coordinates (gdt.core.coords)
• Instrument Detectors (gdt.core.detectors)
• The Geomagnetic Module (gdt.core.geomagnetic)
• HEASARC Data Finders and Catalog Access (gdt.core.heasarc)
• Time Epochs and Utilities (gdt.core.time)

Reduction and Analysis

• The Background Package (gdt.core.background)
• The Binning Package (gdt.core.binning)
• The Simulate Package (gdt.core.simulate)
• The Spectra Package (gdt.core.spectra)

Plotting

• The Plot Package (gdt.core.plot)
  • Plotting DRMs and Effective Area (drm)
  • Plotting Spacecraft in Earth Orbit (earthplot)
  • Plotting Lightcurves (lightcurve)
  • Plotting of Spectral Fits and Models (model)
  • Plot Element Classes (plot)
  • Plotting Sky Maps, Localizations, and Wide-field Effective Area (sky)
  • Plotting Count Spectra (spectra)
  • Low-level Plot Functions (lib)

Contributing

• Contributing to the GDT
  • Opening an Issue
  • Requisites for Pull Requests
  • Contributing to gdt-core
  • Contributing to mission packages
  • Contributing new missions packages

License

• Apache License

Indices and tables

• Index

• Module Index

• Search Page