Welcome to the Fermi GBM Data Tools documentation!

_images/gdt_logo.png

Hello, I’m Fermi. Pleased to meet you!

The Fermi GBM Data Tools is an Application Programming Interface (API) for GBM data. The fundamental purpose of the Data Tools is to allow general users to incorporate GBM analysis into their scripts and workflows without having to sweat very many details. To this end, the Data Tools have a fairly high-level API layer allowing a user to read, reduce, and visualize GBM data with only a few lines of code. For expert users, and users who want fine control over various aspects of their analysis, the Data Tools exposes a lower-level API layer, which can also be used to generalize the GBM Data Tools to data from other like instruments.

Architecture

The Data Tools are designed with generalization in mind. Underlying the science data interfaces are primitive data types that allow similar data to be used with the Data Tools, even if the exact data file definitions are different from the GBM file definitions. The inheritance structure of the Data Tools allows generalization of many of the Data Tools functionality to data from other instruments, once the interface to those data files are defined.

The Data Tools are designed with various aspects to be plugin-like. For example, The Data Tools provides a binning module that contains a number of binning algorithms for pre-binned and unbinned data. A user is not restricted to using only the pre-packaged binning algorithms provided, but can write their own algorithms by following the instructions on the required inputs and outputs expected. The user-defined algorithms can then be used seamlessly with the Data Tools. The same architecture can be leveraged to allow for user-defined background estimation algorithms, spectral models/functions, and spectral fitting algorithms.

Future

We are working to also provide the GBM Data Tools via the NASA GitHub to allow for pull and merge requests from the community. Because the Data Tools could be useful for other similar instruments on previous, current, or future missions, we welcome ideas and interest in helping adapt the Data Tools to your needs.

Citing

If you use the GBM Data Tools in your research and publications, we would definitely appreciate an appropriate acknowledgment and citation! We suggest the following BibTex:

@misc{GbmDataTools,
      author = {Adam Goldstein and William H. Cleveland and Daniel Kocevski},
      title = {Fermi GBM Data Tools: v1.02},
      year = 2020,
      url = {https://fermi.gsfc.nasa.gov/ssc/data/analysis/gbm}
}

Additional Resources

The Fermi Science Support Center is a fantastic resource for all things Fermi. Specifically, for GBM, a lot of useful information about the data products can be found here. For questions, bug reports, and comments, please visit the Fermi Help Desk.

Acknowledgments

The Fermi GBM Data Tools were partially funded by the Fermi Guest Investigator program (NNH18ZDA001N). Special appreciation for the volunteer testers.

Indices and tables