Installing Waveflow

Waveflow requires Python 3.10 or newer. Pick the path that fits you:

  • User Setup — use Waveflow as a library in your own project. pip install from GitHub into a virtual environment; no clone needed. Start here if you just want to build designs with Waveflow.
  • Developer Setup — modify Waveflow, contribute changes, or run the bundled examples and tests. Clone the repository and install in editable mode with the development tools.

The optional AI-assistant integrations — MCP server, OpenAI-backed semantic example search, and the VS Code extension — are covered separately under AI Tooling. None of them are required to use or develop Waveflow.

Table of contents

This site uses Just the Docs, a documentation theme for Jekyll.