Heliokit Documentation

Space-weather data, models, and desktop workflows

Heliokit

A Python toolkit for operational heliophysics workflows: component discovery, data readers, transformation filters, forecast models, pipelines, and a protected desktop distribution.

Get started Desktop package

Install Use the host package

Install Heliokit, inspect available components, and run data or model commands.

Components Compose workflows

Work with data readers, filters, models, tools, and pipelines without changing the desktop codebase.

Python Automate from scripts

Use the Heliokit API for discovery, package installation, and component execution.

Reference Know every input

Check required arguments, accepted formats, defaults, and runtime constraints before a run.

Documentation

• Get Started
  • Choose a Python 3.10 environment
  • Install the host package
  • Inspect components
  • Run a component
  • Use activated shortcuts
• Components
  • Package groups
  • Data readers
  • Filters
  • Models and pipelines
  • Dataset selector syntax
• Demo Data Examples
  • Data inspection
  • 2D visualization
  • 3D VTK visualization
  • Filters and conversion
  • Current CLI coverage
• Command Reference
  • Global option
  • Host commands
  • Data readers
  • Dataset selectors
  • MAG_CHB filter
  • Mesh to VTI: spherical coordinates
  • Mesh to VTI: Cartesian coordinates
  • Batch Mesh to VTI
  • Scatter to VTI
  • Format conversion
  • Data calculator
  • DST and Kp models
  • Geomagnetic pipeline
  • ACWE coronal-hole detection
  • Data download tools
  • Interactive visualization
  • Registered P1 components without headless adapters
• Python API
  • Installation API
  • Component metadata
• Desktop Package
  • Runtime model
  • Environment setup
  • Install and run
  • Protection model
  • Uninstall
• Developer Guide
  • Minimal component package
  • Component factory
  • Entry point groups
  • Design rules
• License
  • Covered packages

Why Heliokit

Heliokit is designed as a Python-native distribution layer around existing space-weather capabilities. The host package discovers installed components through entry points, exposes a small Python API, and keeps command-line workflows consistent across data, filters, models, tools, and pipelines.

The desktop package is delivered separately. It is intended for controlled CPython 3.10 x64 environments where heavyweight scientific dependencies already exist, so the wheel can stay compact while still importing VTK, Qt, TensorFlow, Torch, and related runtime libraries from the environment.