Airalogy DocsOne documentation entry for the Airalogy ecosystem.

Navigate the Python framework, AIMD authoring packages, and protocol execution engine from the same GitHub Pages site.

Airalogy Python

AIMD npm packages

Engine docs

Code in packages

Published Python, npm, and runtime packages live under the monorepo packages directory.

Docs in docs

Each package family owns a VitePress site, assembled into one Pages deployment.

Releases by Changesets

npm and PyPI package metadata move through one release workflow.

Documentation Map

Choose the surface you are working on

The monorepo keeps implementation details separate, but the published documentation should feel like one product. Start from the package family closest to your current workflow.

Python package

Airalogy

Use the core Python APIs for AIMD parsing, structured records, conversion, archive handling, and standardized data digitization.

Open Python docs

npm packages

AIMD

Work with the parser, renderer, editor integrations, recorder UI, examples, and interactive demo for authoring AIMD protocols.

Open AIMD docs

Python and npm engine

Airalogy Engine

Run protocol packages in the shared sandbox image through either the Python API or the Node.js API.

Open engine docs

Install

Package entry points

These commands point at the public package surfaces. Detailed setup, examples, and integration notes live in the package-family docs above.

Airalogy Pythonpip install airalogy

Airalogy Engine Pythonpip install airalogy-engine

AIMD rendererpnpm add @airalogy/aimd-renderer

Airalogy Engine Node.jspnpm add @airalogy/airalogy-engine