hwcomponents-dsent 1.0.3__tar.gz

hwcomponents_dsent-1.0.3/.github/workflows/publish.yaml

@@ -0,0 +1,94 @@
+name: Upload Python Package to PyPI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  release:
+    types: [created]
+
+jobs:
+  build-sdist:
+    name: Build sdist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build sdist
+        env:
+          PYTHONPATH: ${{ github.workspace }}
+        run: |
+          python -m build --sdist
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-sdist
+          path: dist/*.tar.gz
+
+  # The wheel ships a native dsent binary, so each platform needs its own
+  # py3-none-<platform> wheel. Wheels are built from the sdist so the version
+  # comes from its PKG-INFO rather than git (which is unavailable in the
+  # manylinux container). cibuildwheel builds Linux wheels in a manylinux
+  # container and repairs them to a tag PyPI accepts. Platforms without a
+  # wheel fall back to the sdist, which compiles dsent at install time.
+  build-wheels:
+    name: Build wheel on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    needs: build-sdist
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist-sdist
+          path: sdist
+      - name: Locate sdist
+        id: sdist
+        shell: bash
+        run: echo "path=$(ls sdist/*.tar.gz)" >> "$GITHUB_OUTPUT"
+      - name: Build wheel
+        uses: pypa/cibuildwheel@v3.4
+        env:
+          CIBW_BUILD: "cp312-manylinux_x86_64 cp312-macosx_*"
+          CIBW_ARCHS_MACOS: native
+          CIBW_TEST_COMMAND: >-
+            python -c "from hwcomponents_dsent import Router;
+            print(Router(tech_node=45e-9, flit_width=64).route_flit())"
+        with:
+          package-dir: ${{ steps.sdist.outputs.path }}
+          output-dir: wheelhouse
+      - name: Upload wheel
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ matrix.os }}
+          path: wheelhouse/*.whl
+
+  pypi-publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [build-wheels, build-sdist]
+    environment:
+      name: pypi
+      url: https://pypi.org/p/hwcomponents-dsent
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: dist-*
+          merge-multiple: true
+          path: dist
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

hwcomponents_dsent-1.0.3/.gitignore

@@ -0,0 +1,68 @@
+# Python bytecode
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+venv/
+env/
+.env/
+.venv/
+ENV/
+
+# IDE specific files
+.idea/
+.vscode/
+*.swp
+*.swo
+.DS_Store
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Testing
+.coverage
+htmlcov/
+.pytest_cache/
+.tox/
+nosetests.xml
+coverage.xml
+*.cover
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# pip
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Logs
+*.log
+logs/
+
+# Local development settings
+.env
+.env.local
+.env.*.local
+
+# Documentation
+docs/_build/
+site/
+
+# Temporary files
+*.tmp
+*.bak
+*.swp
+*~ 
+hwcomponents_dsent/dsent_inputs_outputs
+hwcomponents_dsent/_version.py
+hwcomponents_dsent/dsent/dsent
+.obj/

hwcomponents_dsent-1.0.3/CLAUDE.md

@@ -0,0 +1,27 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+`hwcomponents_dsent` is a plug-in for [HWComponents](https://accelergy-project.github.io/hwcomponents/) providing NoC `Router` and `NoCLink` models backed by DSENT. It is a sibling of `hwcomponents-cacti` and deliberately mirrors its structure (subprocess call + content-addressed on-disk cache + tech-node interpolation).
+
+## Build / install
+
+```bash
+make build          # compiles all hwcomponents_dsent/dsent/**/*.cc into hwcomponents_dsent/dsent/dsent (objects in .obj/)
+make clean
+pip install -e .    # setup.py's build hook runs `make build`
+hwc --list | grep -iE 'router|link'
+```
+
+Python >= 3.12; `hwcomponents` must be importable at build time (setuptools-scm version scheme). No test suite; smoke-test with `python -c "from hwcomponents_dsent import Router; print(Router(tech_node=45e-9, flit_width=64).route_flit())"`.
+
+## Architecture
+
+- **DSENT source** (`hwcomponents_dsent/dsent/`) is gem5's DSENT copy with its Python-2 C extension (`interface.cc`) and CMake file removed. `main.cc` is our standalone driver: `dsent <cfg> <out>` builds the model from the cfg, runs its `EvaluateString`, and writes each `print "name" expr;` result as `name\tvalue` to `<out>`. DSENT `ASSERT`s abort the process, which is why it runs as a subprocess rather than an extension.
+- **DSENT builds the model from the cfg once** (parameters, then properties, then optional timing optimization to `1/Frequency`). All structural parameters must be in the cfg; nothing can be changed after build.
+- **`_call_dsent`** formats a full cfg from a params dict plus an `evaluate` dict (output name → DSENT calculator expression like `$(Energy>>Router:WriteBuffer)`), hashes it, and caches results in `hwcomponents_dsent/dsent_inputs_outputs/` under an `fcntl` lock. Per-event energies (J), `NddPower` leakage (W), and `Area` (m²) come out in SI units; no conversion is done.
+- **`_interp_tech_node`** interpolates between bulk 22/32/45nm tech models (TG11 only with `include_11nm_trigate=True`). Out-of-range scaling matches hwcomponents-cacti's intent. Scaling class is chosen by output-name prefix (`area*` → area, `leak*` → leakage), so name new outputs accordingly.
+- **Clock power is leakage**: `Router` folds `DistributeClock` energy × frequency into `leak_power` (`self.clock_power`).
+- `ActionCost.throughput` is actions/second: `frequency × n_ports` for router actions, `frequency` for link `send`. Latency is `pipeline_stages / frequency` (router) or `delay` (link, defaults to one cycle and also sets DSENT's repeater-sizing target).

hwcomponents_dsent-1.0.3/Makefile

@@ -0,0 +1,26 @@
+.PHONY: build install clean
+
+DSENT_DIR := hwcomponents_dsent/dsent
+OBJ_DIR := .obj
+DSENT_SRCS := $(shell find $(DSENT_DIR) -name '*.cc')
+DSENT_OBJS := $(patsubst $(DSENT_DIR)/%.cc,$(OBJ_DIR)/%.o,$(DSENT_SRCS))
+CXX ?= g++
+CXXFLAGS ?= -O2 -std=c++11 -w
+CXXFLAGS += -I$(DSENT_DIR)
+
+build: $(DSENT_DIR)/dsent
+	test -x $(DSENT_DIR)/dsent
+
+$(DSENT_DIR)/dsent: $(DSENT_OBJS)
+	$(CXX) $(CXXFLAGS) -o $@ $^
+
+$(OBJ_DIR)/%.o: $(DSENT_DIR)/%.cc
+	@mkdir -p $(dir $@)
+	$(CXX) $(CXXFLAGS) -c -o $@ $<
+
+install:
+	$(MAKE) build
+	pip3 install .
+
+clean:
+	rm -rf $(OBJ_DIR) $(DSENT_DIR)/dsent

hwcomponents_dsent-1.0.3/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: hwcomponents_dsent
+Version: 1.0.3
+Summary: A package for estimating the energy and area of on-chip network routers and links with DSENT
+Author-email: Arunkumar Vaidyanathan <vaidyanathan@ice.rwth-aachen.de>
+License-Expression: MIT
+Keywords: accelerator,hardware,energy,estimation,DSENT,NoC
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: hwcomponents
+
+# HWComponents-DSENT
+
+This package connects [DSENT](https://github.com/gem5/gem5/tree/stable/ext/dsent) to HWComponents. 
+It provides models for electrical network-on-chip routers and links.
+
+These models are for use with the HWComponents package, found at
+https://accelergy-project.github.io/hwcomponents/.
+
+## Installation
+
+```bash
+make build      # compile the standalone DSENT executable
+pip install .
+
+# Check that the installation is successful
+hwc --list | grep -iE 'router|link'
+```
+
+## Models
+
+- `Router`: input-buffered virtual-channel router. Actions: `route_flit` (buffer write +
+  buffer read + switch arbitration + crossbar traversal), and the individual
+  `write_buffer`, `read_buffer`, `arbitrate`, `traverse_crossbar`. Clock-tree power is
+  activity-independent and is included in `leak_power`.
+- `NoCLink`: repeated-wire link. Action: `send`.
+
+```python
+from hwcomponents_dsent import Router, NoCLink
+
+router = Router(tech_node=22e-9, flit_width=64, n_in_ports=5, n_out_ports=5)
+link = NoCLink(tech_node=22e-9, width=64, length=1e-3)
+print(router.route_flit(), router.leak_power, router.area)
+print(link.send(), link.leak_power, link.area)
+```
+
+DSENT ships 22, 32, and 45nm bulk technology models. Other nodes are linearly
+interpolated or extrapolated. Pass `include_11nm_trigate=True` to also use DSENT's 11nm
+tri-gate model.
+
+## Citation
+
+```bibtex
+@inproceedings{sun2012dsent,
+  author={Sun, Chen and Chen, Chia-Hsin Owen and Kurian, George and Wei, Lan and Miller, Jason and Agarwal, Anant and Peh, Li-Shiuan and Stojanovic, Vladimir},
+  booktitle={2012 IEEE/ACM Sixth International Symposium on Networks-on-Chip (NOCS)},
+  title={DSENT - A Tool Connecting Emerging Photonics with Electronics for Opto-Electronic Networks-on-Chip Modeling},
+  year={2012},
+  pages={201-210},
+  doi={10.1109/NOCS.2012.31}
+}
+```

hwcomponents_dsent-1.0.3/README.md

@@ -0,0 +1,51 @@
+# HWComponents-DSENT
+
+This package connects [DSENT](https://github.com/gem5/gem5/tree/stable/ext/dsent) to HWComponents. 
+It provides models for electrical network-on-chip routers and links.
+
+These models are for use with the HWComponents package, found at
+https://accelergy-project.github.io/hwcomponents/.
+
+## Installation
+
+```bash
+make build      # compile the standalone DSENT executable
+pip install .
+
+# Check that the installation is successful
+hwc --list | grep -iE 'router|link'
+```
+
+## Models
+
+- `Router`: input-buffered virtual-channel router. Actions: `route_flit` (buffer write +
+  buffer read + switch arbitration + crossbar traversal), and the individual
+  `write_buffer`, `read_buffer`, `arbitrate`, `traverse_crossbar`. Clock-tree power is
+  activity-independent and is included in `leak_power`.
+- `NoCLink`: repeated-wire link. Action: `send`.
+
+```python
+from hwcomponents_dsent import Router, NoCLink
+
+router = Router(tech_node=22e-9, flit_width=64, n_in_ports=5, n_out_ports=5)
+link = NoCLink(tech_node=22e-9, width=64, length=1e-3)
+print(router.route_flit(), router.leak_power, router.area)
+print(link.send(), link.leak_power, link.area)
+```
+
+DSENT ships 22, 32, and 45nm bulk technology models. Other nodes are linearly
+interpolated or extrapolated. Pass `include_11nm_trigate=True` to also use DSENT's 11nm
+tri-gate model.
+
+## Citation
+
+```bibtex
+@inproceedings{sun2012dsent,
+  author={Sun, Chen and Chen, Chia-Hsin Owen and Kurian, George and Wei, Lan and Miller, Jason and Agarwal, Anant and Peh, Li-Shiuan and Stojanovic, Vladimir},
+  booktitle={2012 IEEE/ACM Sixth International Symposium on Networks-on-Chip (NOCS)},
+  title={DSENT - A Tool Connecting Emerging Photonics with Electronics for Opto-Electronic Networks-on-Chip Modeling},
+  year={2012},
+  pages={201-210},
+  doi={10.1109/NOCS.2012.31}
+}
+```

hwcomponents_dsent-1.0.3/hwcomponents_dsent/__init__.py

@@ -0,0 +1,6 @@
+from .hwcomponents_dsent import *
+
+__all__ = [
+    "Router",
+    "NoCLink",
+]

hwcomponents_dsent-1.0.3/hwcomponents_dsent/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '1.0.3'
+__version_tuple__ = version_tuple = (1, 0, 3)
+
+__commit_id__ = commit_id = 'g05a9fef7c'