NSDF Dark Matter Documentation

Welcome to the documentation for the NSDF Dark Matter initiative!

This set of guides is designed to help you interact and analyze the R76 dark matter dataset using our suite of tools. Whether you are just getting started or diving into advanced workflows, these instructions will walk you through installation, setup, and usage.

⚡Quick Start

• 🔧 CLI Guide: Learn how to access and download dark matter datasets using the nsdf-cli command-line interface.
• 📚 Library Guide: Explore how to load and analyze a dark matter dataset using the Python API.
• 📊 Dashboard Guide: Understand the components of the web-based dashboard for visualizing dark matter events and detectors.

🚀 Features

• Web-based visualization: Explore midas files, isolate detector channels, and examine detailed metadata such as trigger types and time stamps, all within the browser with the NSDF Dark Matter Dashboard.
• Easy data access via CLI: Effortlessly search, and download dark matter data files using the NSDF Dark Matter CLI.
• Workflow integration: Leverage NSDF Dark Matter Library to load and manipulate dark matter data, enabling seamless integration into workflow pipelines, including machine learning.
• Search events: Search for specific events using the autocomplete input.
• Visualization: Visualize channel waveforms from multiple detectors.
• Channel isolation: Select or deselect channels from one or more detectors.
• Event metadata: View information about the trigger type, readout type, and timestamp of the events.

Next Steps

Start by exploring the CLI Guide to download data or visit the web-based Dashboard to visualize the data.