SGN Documentation

SGN is a lightweight Python library for building streaming data pipelines. Connect sources, transforms, and sinks into clear workflows while SGN handles asynchronous execution under the hood. Zero external dependencies.

Installation

pip install sgn

Developer Installation

git clone https://git.ligo.org/greg/sgn.git
cd sgn
pip install -e ".[dev]"

The dev extras include tools for docs, linting, testing, and monitoring. Run make to verify your development environment.

Where to Start

• Tutorial — New to SGN? Build your first pipeline step by step.
• User Guide — Solve specific problems: connecting elements, grouping, parallelism, and more.
• Background — Understand how SGN works: execution model, core concepts, and design decisions.
• Reference — Elements and auto-generated API documentation.

Related Libraries

• sgn-ts: TimeSeries utilities for SGN
• sgn-ligo: LSC specific utilities for SGN