```{toctree}
---
maxdepth: 2
hidden: true
---



docs/tutorial/first-build.md

docs/how-to/run-a-build.md

docs/how-to/program-hardware.md

docs/how-to/extend-dau-build.md

docs/reference/commands.md

docs/reference/config-groups.md

docs/reference/tasks-and-steps.md

docs/explanation/architecture.md


```

# dau build

Build tools for dau

[![Build Status](https://github.com/dau-dev/dau-build/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/dau-dev/dau-build/actions/workflows/build.yaml)
[![codecov](https://codecov.io/gh/dau-dev/dau-build/branch/main/graph/badge.svg)](https://codecov.io/gh/dau-dev/dau-build)
[![License](https://img.shields.io/github/license/dau-dev/dau-build)](https://github.com/dau-dev/dau-build)
[![PyPI](https://img.shields.io/pypi/v/dau-build.svg)](https://pypi.python.org/pypi/dau-build)

## Overview

`dau-build` turns declarative FPGA build specs into concrete artifacts: generated SystemVerilog, `artlink.manifest/v0` artifact bundles, backend handoff manifests, Vivado Tcl, and ordered hardware command plans. Every operation is a typed `ccflow.CallableModel` composed from a Hydra config tree in `dau_build/config`, so the whole pipeline composes, inspects, and tests on a development machine, with the privileged steps (Vivado, JTAG, PCIe) gated behind an explicit `execute=true`.

Two synthesis engines are supported: Vivado (the FPGA bitstream flow) and yosys (open-source synthesis that runs in CI). The config plumbing is backend-agnostic, so more can be added.

Composition is the extension mechanism: any package can register its own config tree on the shared Hydra search path via a `hydra.lernaplugins` entry point, and its task/design/board groups compose through this CLI without dau-build importing that package. The core registry itself arrives this way — `dau-core` publishes every hardware building block as a `CoreDefinition` at `/dau-core/<name>`, and the `synthesize-cores` task resolves cores from that registry to run per-core out-of-context characterization (staged Tcl + command plan anywhere; `model.execute=true` on a synthesis host runs Vivado and flags envelope drift against the registered numbers):

```bash
dau-build task=tasks/build/synthesize-cores   'model.cores=[/dau-core/int32-predicate-filter]'   model.output_root=outputs/ooc model.part=xc7a200tfbg484-2
```

## Quickstart

Build the checked-in identity example — no board or vendor tools required:

```bash
dau-build task=tasks/spec/inspect  model.spec_path=examples/identity/dau-build.yaml
dau-build task=tasks/spec/build     model.spec_path=examples/identity/dau-build.yaml model.output_root=outputs/identity
dau-build task=tasks/spec/validate  model.manifest_path=outputs/identity/dau-identity.manifest model.root=outputs/identity
dau-build task=tasks/sim/simulate   model.module=dau_identity_top model.spec_path=examples/identity/dau-build.yaml
```

Task and step names are path-style, mirroring the config tree (`task=tasks/spec/inspect`, `step=steps/inspect`).

## Documentation

The documentation is organized into four sections:

- **Tutorial** — [Build the identity example](docs/tutorial/first-build.md).
- **How-to** — [Run a build end to end](docs/how-to/run-a-build.md) · [Program a bitstream on dpv1](docs/how-to/program-hardware.md) · [Extend dau-build](docs/how-to/extend-dau-build.md).
- **Reference** — [Commands](docs/reference/commands.md) · [Config groups](docs/reference/config-groups.md) · [Task and step catalog](docs/reference/tasks-and-steps.md).
- **Explanation** — [Architecture](docs/explanation/architecture.md): how Hydra composition, ccflow evaluation, and the search-path extension model work, and the current state of backend support.

> [!NOTE]
> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).