# shmpipeline

`shmpipeline` builds local process-based compute pipelines on top of named shared-memory streams from `pyshmem`.

The documentation site is organized around four user paths:

- getting a pipeline running quickly
- understanding the CLI, runtime model, and GUI
- studying complete worked examples
- looking up the Python API and built-in kernel catalog

```{toctree}
:maxdepth: 2
:caption: Getting Started

getting-started/installation
getting-started/quickstart
getting-started/configuration
```

```{toctree}
:maxdepth: 2
:caption: Guides

guides/cli
guides/control-plane
guides/runtime
guides/gui
guides/extensions
guides/troubleshooting
```

```{toctree}
:maxdepth: 2
:caption: Worked Examples

examples/index
```

```{toctree}
:maxdepth: 2
:caption: API Reference

reference/index
```