SWxSOC Core Documentation¶
This is the documentation for the swxsoc Python package.
swxsoc helps space weather and heliophysics missions create, validate, and manage archive-ready CDF data files, and provides shared tools for running mission science data pipelines.
New here?
To install
swxsocfrom PyPI or GitHub, see the Installation Guide.To create a CDF file from your own data, start with Reading and Writing CDF Data with SWXData.
For one-line answers to common tasks, see the Quick Reference.
- Release History
- User’s Guide
- Installation Guide
- Quick Reference
- Reading and Writing CDF Data with SWXData
- Validating CDF Data
- Tagging Missing or Bad Data: FILLVAL and Masks
- Using SWxSOC Schema for Metadata Attributes
- CDF Format Guide
- SWxSOC Environment and Mission Configuration
- Record Measurements to Mission Timeseries Database
- Tracking Science Files (MetaTracker)
- Managing Grafana Annotations with the
swxsocPackage - Retrieving and Downloading Data
- Logging system
- Pipeline Notifications (Comms)
- Developer’s Guide
- API Reference
- swxsoc Package
- swxsoc.comm Package
- swxsoc.db Package
- swxsoc.db.tables Package
- swxsoc.db.timeseries Module
- swxsoc.db.tracker Module
- swxsoc.io Package
- swxsoc.io.base_handler Module
- swxsoc.io.cdf_handler Module
- swxsoc.io.fillval Module
- swxsoc.io.s3 Module
- swxsoc.net Package
- swxsoc.net.attr Module
- swxsoc.net.client Module
- swxsoc.swxdata Module
- swxsoc.util Package
- swxsoc.util.config Module
- swxsoc.util.const Module
- swxsoc.util.exceptions Module
- swxsoc.util.grafana Module
- swxsoc.util.logger Module
- swxsoc.util.reprocessing Module
- swxsoc.util.schema Module
- swxsoc.util.util Module
- swxsoc.util.validation Module
- Examples
