dau-core 0.1.1__tar.gz

dau_core-0.1.1/.gitignore

@@ -0,0 +1,168 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.a
+*.o
+*.dSYM
+*.so
+*.obj
+*.dll
+*.exp
+*.lib
+
+# vcpkg
+vcpkg/
+vcpkg_installed/
+
+# Rust
+target
+target-capi
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+junit.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Django
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# Celery
+celerybeat-schedule
+celerybeat.pid
+
+# Airspeed Velocity
+.asv
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Documentation
+/site
+index.md
+docs/_build/
+docs/api
+docs/html
+docs/index.md
+docs/jupyter_execute
+docs/src/_build/
+docs/superpowers
+index.md
+
+# JS
+js/coverage
+js/dist
+js/lib
+js/node_modules
+js/test-results
+js/playwright-report
+js/*.tgz
+
+# Jupyter
+.ipynb_checkpoints
+.autoversion
+Untitled*.ipynb
+dau_core/extension
+dau_core/nbextension
+dau_core/labextension
+
+# Emscripten SDK (locally installed)
+emsdk
+.pyodide_build/
+
+# Mac
+.DS_Store
+
+# Hydra
+/outputs/
+/multirun/
+
+# Rendered output of generated cores. This is the default render root, so a
+# test run or a render-cores task materializes tiles here; committing them
+# leaves a second copy of a tile that only the operating point defines, and
+# whichever of the two is stale is the one that gets synthesized.
+dau_core/hdl/generated/
+
+# AI
+ROADMAP.md
+AGENTS.md
+.github/hooks/sdlc.json
+.superpowers

dau_core-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 the dau-core authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dau_core-0.1.1/PKG-INFO

@@ -0,0 +1,292 @@
+Metadata-Version: 2.5
+Name: dau-core
+Version: 0.1.1
+Summary: Core IP for dau projects
+Project-URL: Repository, https://github.com/dau-dev/dau-core
+Project-URL: Homepage, https://github.com/dau-dev/dau-core
+Author-email: the dau-core 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: ccflow>=0.9
+Requires-Dist: hydra-core
+Requires-Dist: pydantic>=2
+Provides-Extra: develop
+Requires-Dist: build; extra == 'develop'
+Requires-Dist: bump-my-version; extra == 'develop'
+Requires-Dist: check-dist; extra == 'develop'
+Requires-Dist: cocotb; extra == 'develop'
+Requires-Dist: codespell; extra == 'develop'
+Requires-Dist: dau-build>=0.15; extra == 'develop'
+Requires-Dist: dau-sim; 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: omegaconf; 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: wheel; extra == 'develop'
+Description-Content-Type: text/markdown
+
+# dau core
+
+Hardware contracts, golden semantics, and the core registry for the DAU accelerator stack
+
+[![Build Status](https://github.com/dau-dev/dau-core/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/dau-dev/dau-core/actions/workflows/build.yaml)
+[![codecov](https://codecov.io/gh/dau-dev/dau-core/branch/main/graph/badge.svg)](https://codecov.io/gh/dau-dev/dau-core)
+[![License](https://img.shields.io/github/license/dau-dev/dau-core)](https://github.com/dau-dev/dau-core)
+[![PyPI](https://img.shields.io/pypi/v/dau-core.svg)](https://pypi.python.org/pypi/dau-core)
+
+## Overview
+
+`dau-core` holds the definitions the other DAU packages share:
+
+- **The core registry.** Every HDL building block (streaming operator
+  tiles, AXI stream infrastructure, shell adapters, shared packages) is
+  described by a `CoreDefinition`: its module, sources, dependencies,
+  golden model, testbench, measured resources, module parameters, and
+  stream-contract facts.
+- **Golden models.** Each operator has a pure-Python reference
+  implementation. Hardware results are compared byte for byte against it,
+  so the golden defines what the tile computes.
+- **Wire contracts.** Register maps, stream framing structs, DMA
+  constraints, capability advertisement, and composition specs.
+
+The package also ships the SystemVerilog for every registered core.
+Every operator tile has a golden, a cocotb bench under Verilator, and
+measured resource points. The stream infrastructure and shell adapters
+are tested inside the composed shells instead of one by one. Five tiles
+generate their source from their parameters when rendered.
+
+## Documentation
+
+The full documentation is at
+[dau-dev.github.io/dau-core](https://dau-dev.github.io/dau-core/).
+
+- **Tutorial**: [Read a tile's contract end to end](docs/src/tutorial/read-a-tile-contract.md)
+  follows one operator through the five places its definition lives.
+- **How-to guides**: [Add an operator tile](docs/src/how-to/add-an-operator-tile.md) ·
+  [Test a core](docs/src/how-to/test-a-core.md) ·
+  [Measure a resource envelope](docs/src/how-to/measure-a-resource-envelope.md), the one
+  step that needs a synthesis host · [Develop and contribute](docs/src/how-to/develop.md).
+- **Reference**: [`CoreDefinition` fields](docs/src/reference/core-definition.md) ·
+  [Registry guards](docs/src/reference/registry-guards.md) and what each one checks.
+- **Explanation**: [Why cores are declared in config](docs/src/explanation/why-cores-are-declared-in-config.md) ·
+  [Why each tile has a golden model](docs/src/explanation/why-each-tile-has-a-golden-model.md) ·
+  [Why resource costs are measured](docs/src/explanation/why-resources-are-measured.md).
+
+## The core registry
+
+Cores are declared in a [Hydra](https://hydra.cc) config tree,
+`dau_core/config/dau-core/cores.yaml`, with one `CoreDefinition` entry per
+core, and loaded into the [ccflow](https://github.com/Point72/ccflow)
+`ModelRegistry` at `/dau-core/<core-name>`. The package adds the tree to the
+shared Hydra search path through a `hydra.lernaplugins` entry point, so an
+application that composes Hydra configs finds the cores without importing
+`dau_core`.
+
+```python
+from dau_core.registry import loaded_cores, core, sources_for
+
+cores = loaded_cores()                     # name -> CoreDefinition, registry order
+tile = core("int32-predicate-filter")      # one core
+print(tile.kind.value)                     # "operator"
+print(tile.golden)                         # "dau_core.operators:filter_values"
+print(tile.resources)                      # measured LUT/FF/BRAM/DSP envelope
+
+sources_for("stream-aggregation")    # dependency-closed HDL paths, in order
+```
+
+The palette has 46 operator tiles (filters, maps, ordered and hash-mode
+aggregations, joins, membership, sorters, partitioners, dispatchers,
+temporal operators, top-k, fixed-point transcendentals, and the stateful
+group), 5 stream-infrastructure blocks (AXI burst reader, broadcast, record
+writer, write mux, row unpacker), 4 shell adapters, 3 shared SV packages,
+and 1 simulation model: 59 entries in all. `loaded_cores()` returns the
+current list. If an application has already composed the registry, with or
+without overrides, the accessors read that composition instead of loading
+the packaged defaults.
+
+## Golden models
+
+Each operator tile's behavior is defined by a pure function or small model
+in `dau_core.operators` or `dau_core.temporal`. Tile configurations are
+frozen [pydantic](https://docs.pydantic.dev) models that mirror the tile's
+config ports, and the same object drives the golden, the testbench, and
+design emission. Their mapping fields are read-only, `replace()` is a
+`model_copy` that validates the result, and `check()` validates a model
+again on demand, so a copy that skipped validation is rejected before
+anything hashes or prices it.
+
+```python
+from dau_core.operators import (
+    PredicateOp, RowField, RowPredicateConfig, RowPredicateTerm,
+    filter_rows_by_predicate, streaming_top_k,
+)
+
+config = RowPredicateConfig(
+    term0=RowPredicateTerm(field=RowField.VALUE, op=PredicateOp.GT, constant=10),
+)
+rows = [(1, 5, 0, 0), (2, 25, 0, 0), (3, 11, 0, 0)]
+filter_rows_by_predicate(rows, config)   # -> [(2, 25, 0, 0), (3, 11, 0, 0)]
+
+streaming_top_k(rows, k=2)               # ORDER BY key DESC LIMIT 2, ties by arrival
+```
+
+`dau_core.temporal` covers the time-series operators (backward as-of join,
+market features, time/volume/dollar/imbalance bars, rolling moments, EWMA)
+in an exact-integer domain: divisions are deferred to the host, so goldens
+and hardware agree bit-for-bit.
+
+## Composition specs
+
+A shell datapath is described as data: `ScanCompositionSpec` names
+registry cores, their config-port bindings, and module-parameter overrides
+for a one-scan-N-lanes design. Construction validates everything against
+the registry (operator kinds, status-contract roles, declared parameter
+bounds) and raises `CompositionError` before any HDL is generated;
+`estimated_resources` prices a spec from the measured envelopes.
+
+```python
+from dau_core.composition import LaneSpec, ScanCompositionSpec, TileSpec, estimated_resources
+
+spec = ScanCompositionSpec(
+    name="bar-noc-4",
+    lanes=tuple(
+        LaneSpec(
+            tile=TileSpec(core="bar-aggregation", config={"cfg_mode": "2'd0"}),
+            partition=TileSpec(core="pair-key-filter",
+                               config={"cfg_key_mask": "32'd3", "cfg_key_match": f"32'd{lane}"}),
+        )
+        for lane in range(4)
+    ),
+)
+print(estimated_resources(spec, part="xc7a200tfbg484-2", clock_ns=8.0))
+```
+
+Pricing needs a part and a clock. Each core is looked up at exactly that
+part, clock, and parameter set, and a combination that has not been
+measured raises `UnmeasuredResourceError` naming it. Nothing is
+interpolated.
+
+### Wide lanes
+
+A quad-row operator core takes one row per beat at the rate its `ingest`
+contract declares (one row per cycle or per two cycles, depending on the
+tile). A `wide-row-stream` core takes the reader's whole beat,
+`SLOTS = data_width / 128` quad rows every cycle, with no dispatcher and no
+fan-out. The three row operators have wide counterparts
+(`wide-row-predicate-filter`, `wide-row-map-alu`,
+`wide-field-sum-aggregation`) that take the same configs in the same order;
+only the core names change.
+
+`data_width` must equal `SLOTS * 128` or construction raises
+`CompositionError`. A wide lane cannot use the packed front unpacker,
+because packing saves DMA bytes at the cost of job time and a wide lane
+needs whole rows.
+
+```python
+from dau_core.composition import LaneSpec, ScanCompositionSpec, TileSpec, estimated_resources
+
+spec = ScanCompositionSpec(
+    name="q6-wide",
+    data_width=512,   # SLOTS=4: four quad rows per cycle
+    lanes=(
+        LaneSpec(
+            tile=TileSpec(core="wide-field-sum-aggregation",
+                          config={"cfg_field_mask": "4'b0010"}),
+            chain=(
+                # shipdate >= 8766 AND shipdate < 9131
+                TileSpec(core="wide-row-predicate-filter", config={
+                    "cfg_field0": "2'd0", "cfg_op0": "3'd6", "cfg_constant0": "32'd8766",
+                    "cfg_combine01": "2'd1",
+                    "cfg_field1": "2'd0", "cfg_op1": "3'd3", "cfg_constant1": "32'd9131",
+                    "cfg_combine2": "2'd0",
+                    "cfg_field2": "2'd0", "cfg_op2": "3'd0", "cfg_constant2": "32'd0"}),
+                # value = value * aux0 >> 15
+                TileSpec(core="wide-row-map-alu", config={
+                    "cfg_op": "3'd4", "cfg_dst_field": "2'd1",
+                    "cfg_src_a_field": "2'd1", "cfg_src_b_field": "2'd2",
+                    "cfg_shift": "5'd15"}),
+            ),
+        ),
+    ),
+)
+print(estimated_resources(spec, part="xc7k325tffg900-2", clock_ns=8.0))
+```
+
+The rate model predicts rows / SLOTS / clock. At SF1 that is
+6,001,215 / 4 / 125 MHz = 12.0 ms, and the job measures 12.4 ms on
+hardware.
+
+## Workflows and typed results
+
+Multi-stage reference workflows are ccflow `CallableModel`s with typed
+`ResultBase` results, so they can be registered and composed with Hydra
+like the rest of the package. `dau_core.workflows.HeroWorkflow` runs the
+temporal pipeline (as-of align, feature map, time bars, rolling moments)
+over the goldens and records the row count at each stage and a per-stage
+materialization cost (`dau_core.hero`).
+
+```python
+from ccflow import GenericContext
+from dau_core.temporal import generate_market_stream
+from dau_core.workflows import HeroWorkflow
+
+stream = generate_market_stream(seed=7, num_symbols=3)
+result = HeroWorkflow(bar_width=64, roll_window=3)(GenericContext(value=stream))
+print(result.funnel)   # input -> matched -> bars -> rolling row counts
+```
+
+## Wire contracts
+
+- `dau_core.registers`: the DAU magic word, register/protocol versions,
+  register offsets, reset scopes, and the stream-job register contract
+  (trigger/status/buffer addresses).
+- `dau_core.stream`: Arrow-lite framing (`BatchHeader`,
+  `ColumnDescriptor`, `OperationDescriptor`), logical types, operation
+  codes, record-batch limits, and shared error codes.
+- `dau_core.capabilities`: DMA constraints and device/operator
+  capability models populated from a live device.
+- `dau_core.capability_contract`: the composed capability advertisement
+  a built shell publishes, derived from its composition spec.
+- `dau_core.design`: the operator-unit inventory parsed back from a
+  synthesized design's manifest.
+
+## HDL and verification
+
+`dau_core/hdl/` holds the SystemVerilog for every registered core, five of
+them generated at render time. Tiles share a 64-bit valid/ready stream and
+status contract: `input_last` ends a batch, a terminal tile closes out with
+a status word and count, and mid-lane stages stay silent on success. The
+tests run at three levels, all from `pytest`:
+
+- text-contract checks over the packaged sources;
+- standalone Verilator benches;
+- cocotb-on-Verilator benches, golden-equal against the registered
+  reference for each tile.
+
+## Installation
+
+Requires Python 3.11 or newer.
+
+```bash
+pip install dau-core
+```
+
+> [!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).