Welcome to BurstCube’s documentation!

Introduction

This is the BurstCube’s documentation page. For more information about the misson, please refer to the BurstCube Website.

BurstCube’s documentation is built with a series of different functions and modules that allow the following:

• Creating different geometry files to allow for new arrangements of BurstCube to be subject to testing.
• Creating source files of ranging sky locations and energies.
• Quick manipulation of the MEGAlib Cosima function to permit quick simulations.
• Packages such as bcSim and plotSim that grant fast and effective data processing.

BurstCube uses a configuration-file driven workflow in which the analysis parameters (data selection, IRFs, and ROI model) are defined in a YAML configuration file. Analysis is executed through a python script.

Getting Help

If you have questions about using this please open a GitHub Issue or email me or my boss.

Documentation Contents

• Installation
• Tutorial
  • 1. Creating source files
  • 2. Running simulations
  • 3. Analyzing results
• BurstCube
  • simGenerator module
  • bcSim module
  • plotSim module
  • utils module
• LocSim
  • Detector module
  • GRB module
  • Spacecraft module
  • Stats module
  • Utils module
• NoahSim
  • GRBgenerator module
  • fastcube module
  • burstutils module