Welcome to RadBurst Documentation

This documentation provides a guide to the software developed for the MDP Heliophysics Research Team. The goal is to detect and classify solar radio bursts from spectrogram data collected by our LWA antennas.

Below are links to key sections of the documentation:

Developer Guide

• Installation: Instructions for setting up the project on your local machine.
• Development Workflow: Best practices and guidelines for contributing to the project.
• Updating Documentation: Instructions for maintaining and updating documentation.

Code Reference

• Reference Overview: Overview of the codebase structure and main components.
• Utilities: General utility functions for data handling and visualization.
• Preprocessing: Functions for data preprocessing and standardization.
• Detection: Algorithms for detecting solar radio bursts.
• Classification: CNN-based classification of solar radio bursts.

Examples

• Examples:

Repository Structure

data/                   # Explanations and links to datasets and sample data
docs/                   # Documentation (.md files)
notebooks/              # Jupyter notebooks
    exploration/        # Notebooks for data exploration, testing ideas and analysis        
    evaluation/         # Notebooks evaluating models and algorithms
    examples/           # Notebooks demonstrating how to use code
radburst/               # Main directory for code developement
    detection/          # Burst detection code
    classification/     # Burst classification code
    utils/              # Common utility functions (e.g. load, preprocess, etc.)
requirements.txt        # Project dependencies (read by setup.py when "pip install -e ." is run)
mkdocs.yml              # Configuration for MkDocs documentation