User’s Guide

Welcome to our User guide. For more details checkout the API Reference.

• Brief Tour
• Opening and Writing SWxSOC Affiliated Data
  • Overview
  • Creating a SWXData object
  • Creating a SWXData from an existing CDF File
  • Adding data to a SWXData Container
  • Adding metadata attributes
  • Visualizing data in a SWXData Container
  • Writing a CDF File
  • Validating a CDF File
• Record Measurements to AWS Timestream
  • Writing data
• Managing Grafana Annotations with the swxsoc Package
  • Overview
  • Prerequisites
• Getting a Grafana API Key via a Service Account
  • Creating a Service Account API Key
  • Storing the API Key Securely
  • Best Practices
  • Requesting Access
  • Usage Examples
  • Complete Example
• Using SWxSOC Schema for Metadata Attributes
  • Overview
  • Creating a SWxSOC Schema
  • Global Attribute Schemas
  • Variable Attribute Schemas
• CDF Format Guide
  • 1. Introduction
  • 2. Conventions
  • 3. Global Attributes
  • 4. Variables
• Customization and Global Configuration
  • The config.yml file
  • Using your own config.yml file
  • Customizing the Mission Configuration
  • Reconfiguring for Testing
• Retrieving and Downloading Data
  • Attributes for Searching Data
  • Examples for Searching Data
  • Downloading Data
• Logging system
  • Overview
  • Configuring the logging system
  • Context managers