Get Started¶

Heliokit targets a controlled 64-bit CPython 3.10 environment. The current packages are pinned to Python 3.10 because the desktop repository contains compiled extensions and native scientific dependencies built for that runtime.

Choose a Python 3.10 environment¶

There are two supported installation paths. The Conda path is recommended: it keeps Heliokit and its native scientific dependencies isolated from other Python projects.

Use an existing Python 3.10 environment

Use a managed 64-bit CPython 3.10 installation that already has the required runtime dependencies. Confirm the interpreter before installing:
```
python --version
python -c "import struct; print(struct.calcsize('P') * 8)"
```
The commands must report Python 3.10.x and 64 respectively.
Create a Conda Python 3.10 environment (recommended)

Create and activate a dedicated environment, then update pip inside that environment:
```
conda create --name heliokit python=3.10 --yes
conda activate heliokit
python -m pip install --upgrade pip
```
Run all later python and pip commands from this activated environment. A different environment name is fine, provided it is a 64-bit Python 3.10 environment.

Install the host package¶

Install the host package from PyPI:

python -m pip install heliokit

The host package and individual components install their own lightweight Python dependencies. They do not require the full desktop scientific stack unless a specific component needs it at runtime.

Install the component packages you need. For example:

python -m pip install heliokit-data-vti heliokit-data-cdf
python -m pip install heliokit-filter-data-calculator heliokit-viz2d-histogram2d

You can also ask the host package to install components from PyPI:

heliokit components install --online heliokit-data-vti heliokit-viz3d-volume

Inspect components¶

heliokit components list
heliokit components list --kind data

Run a component¶

heliokit data read vti D:\data\volume.vti

heliokit run model kp --mode predict --results-dir D:\runs\kp

heliokit run pipeline geomag --output D:\runs\geomag\summary.json

Use activated shortcuts¶

In PowerShell, activate short component commands in the current terminal:

heliokit activate --no-prompt | Invoke-Expression
vti D:\data\volume.vti
histogram2d --help

Use heliokit activate without --no-prompt when you also want the prompt to show (heliokit).