heliokit

Heliokit CLI host package.

This package provides:

• heliokit console entrypoint
• component discovery via entry_points
• local development fallback that scans sibling component pyproject.toml files
• a small Python API (Heliokit)

Current package metadata is pinned to Python 3.10.

Inside this repository, the CLI acts as a bridge layer over the existing desktop-side algorithm modules under the repository root.

Quick Start

Install Heliokit from PyPI:

python -m pip install heliokit

This installs the standard first-party components except model packages, the MCCHD CNN workflow, and the geomagnetic pipeline. Use the explicit no-model spelling when you want that intent visible in scripts:

python -m pip install "heliokit[no-model]"

Install the optional model stack only when needed:

python -m pip install "heliokit[models]"

Then list discovered components:

heliokit components list

Python API

from heliokit import Heliokit

kit = Heliokit()
components = kit.list_components("data")
summary = kit.read_data("swv", input="D:/data/sample.swv", include_values=True)

For a fuller monorepo guide, command examples, and component parameter conventions, see cli/README.md.