Metadata-Version: 2.5
Name: dau-build
Version: 0.15.0
Summary: Build tools for dau
Project-URL: Repository, https://github.com/dau-dev/dau-build
Project-URL: Homepage, https://github.com/dau-dev/dau-build
Author-email: the dau authors <dev@dau.dev>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.11
Requires-Dist: amaranth
Requires-Dist: artlink
Requires-Dist: ccflow>=0.8.5
Requires-Dist: dau-sim>=0.2.0
Requires-Dist: dau-utils
Requires-Dist: hydra-core
Requires-Dist: lerna>=2.0.4
Requires-Dist: omegaconf
Requires-Dist: pydantic
Requires-Dist: pyslang>=11
Requires-Dist: pyyaml
Requires-Dist: typing-extensions
Provides-Extra: develop
Requires-Dist: build; extra == 'develop'
Requires-Dist: bump-my-version; extra == 'develop'
Requires-Dist: check-dist; extra == 'develop'
Requires-Dist: cocotb>=2.0.1; extra == 'develop'
Requires-Dist: codespell; extra == 'develop'
Requires-Dist: hatchling; extra == 'develop'
Requires-Dist: mdformat; extra == 'develop'
Requires-Dist: mdformat-frontmatter; extra == 'develop'
Requires-Dist: mdformat-tables>=1; extra == 'develop'
Requires-Dist: pytest; extra == 'develop'
Requires-Dist: pytest-cov; extra == 'develop'
Requires-Dist: ruff; extra == 'develop'
Requires-Dist: twine; extra == 'develop'
Requires-Dist: ty; extra == 'develop'
Requires-Dist: uv; extra == 'develop'
Requires-Dist: verilator; extra == 'develop'
Requires-Dist: wheel; extra == 'develop'
Description-Content-Type: text/markdown

# 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)

## Overview

`dau-build` turns a declarative FPGA build spec into the files a build needs: generated SystemVerilog, `artlink.manifest/v0` artifact bundles, backend handoff manifests, Vivado Tcl, and ordered hardware command plans. The operations are typed `ccflow.CallableModel`s composed from the Hydra config tree in `dau_build/config`. The whole pipeline composes, inspects and tests on a development machine; the steps that need Vivado, a JTAG cable or a PCIe bus run only when you pass `execute=true`.

Two synthesis engines are supported: Vivado for the FPGA bitstream flow, and yosys for open-source synthesis that runs in CI. The config plumbing does not depend on either, so more can be added.

Other packages extend dau-build by composition rather than by editing it. A package registers its own config tree on the shared Hydra search path through a `hydra.lernaplugins` entry point, and its task, design and board groups then compose through this CLI without dau-build importing the package. The core registry arrives the same way: `dau-core` publishes each hardware building block as a `CoreDefinition` at `/dau-core/<name>`, and the `synthesize-cores` task resolves cores from that registry to characterize them one at a time, out of context. Without a synthesis host it stages the Tcl and a command plan; with `model.execute=true` on a machine that has Vivado it runs the synthesis and reports any drift from the resource and timing envelope the registry records:

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

## Installation

Python 3.11 or later. There is no package index release yet; install from a clone or straight from GitHub:

```bash
pip install git+https://github.com/dau-dev/dau-build.git
```

For development, clone and run `make develop`. Vivado and yosys are needed only for the steps that run them; everything else composes, generates and tests without them.

## Quickstart

Build the checked-in identity example. No board and no vendor tools are needed:

```bash
dau-build task=tasks/spec/inspect  spec=specs/identity
dau-build task=tasks/spec/build     spec=specs/identity 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   spec=specs/identity model.module=dau_identity_top
```

Task names are paths into the config tree (`task=tasks/spec/inspect`).

## Documentation

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