cocotbext-ryusim 0.1.0__tar.gz

cocotbext_ryusim-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,82 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 3 * * 1"  # weekly, Mondays 03:00 UTC: catches new RyuSim releases
+  workflow_dispatch:
+
+jobs:
+  smoke:
+    name: smoke (py${{ matrix.python }}, ${{ matrix.cocotb }})
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.9", "3.13"]
+        cocotb: ["cocotb==2.1.0", "cocotb>=2.1,<2.2"]  # cap floor, newest under cap
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install toolchain, Icarus and RyuSim
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends clang cmake iverilog
+          curl -fsSL https://ryusim.seiraiyu.com/install.sh | bash
+          echo "$HOME/.ryusim/bin" >> "$GITHUB_PATH"
+      - name: Install package
+        run: |
+          python -m pip install --upgrade pip
+          pip install "${{ matrix.cocotb }}" -e ".[test]"
+      - name: Versions
+        run: |
+          ryusim --version
+          python -c "import cocotb; print('cocotb', cocotb.__version__)"
+      - run: pytest -v
+
+  conformance:
+    # cocotb's full Verilog regression through this package (§7.2). It takes
+    # about 10 minutes, so it runs on main and weekly, not on every PR.
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install toolchain and RyuSim
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends clang cmake
+          curl -fsSL https://ryusim.seiraiyu.com/install.sh | bash
+          echo "$HOME/.ryusim/bin" >> "$GITHUB_PATH"
+      - name: Install cocotb and this package
+        run: pip install "cocotb>=2.1,<2.2" .
+      - name: Check out cocotb's test suite at the installed version
+        run: |
+          V=$(python -c "import cocotb; print(cocotb.__version__)")
+          git clone --depth 1 --branch "v$V" https://github.com/cocotb/cocotb.git cocotb-src
+      - name: Install cocotb's test dependencies (psutil, pexpect, ...)
+        run: |
+          python -m pip install --upgrade pip  # --group needs pip >= 25.1
+          pip install --group cocotb-src/pyproject.toml:test_common
+      - name: Make RyuSim visible to cocotb's stock test Makefiles
+        # CI-only: users never do this (§5.1). cocotb's test Makefiles use the
+        # stock include, which only searches cocotb's own install dir.
+        run: |
+          cp "$(cocotbext-ryusim-config --makefiles)/simulators/Makefile.ryusim" \
+             "$(cocotb-config --makefiles)/simulators/"
+      - name: Run cocotb's Verilog regression
+        working-directory: cocotb-src
+        env:
+          SIM: ryusim
+          TOPLEVEL_LANG: verilog
+          # Stock Makefile.inc doesn't know ryusim; our shim sets this for users.
+          COCOTB_TRUST_INERTIAL_WRITES: "1"
+          # cocotb's test_ci.test_python_version runs under GITHUB_ACTIONS and
+          # expects its CI to export this; keep in step with setup-python above.
+          PYTHON_VERSION: "3.12"
+        run: make -k test

cocotbext_ryusim-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,82 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Tag matches package version
+        run: |
+          V=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          test "v$V" = "${GITHUB_REF_NAME}" || { echo "tag ${GITHUB_REF_NAME} != v$V"; exit 1; }
+      - run: pip install build && python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  testpypi:
+    needs: build
+    runs-on: ubuntu-24.04
+    environment: testpypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  verify:
+    needs: testpypi
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install toolchain, Icarus and RyuSim
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends clang cmake iverilog
+          curl -fsSL https://ryusim.seiraiyu.com/install.sh | bash
+          echo "$HOME/.ryusim/bin" >> "$GITHUB_PATH"
+      - name: Install the published artifact from TestPyPI
+        # Dependencies come from real PyPI first. Only this package is fetched
+        # from TestPyPI, with --no-deps: anyone can upload to TestPyPI, and
+        # mixing the indexes would let a planted "cocotb" there win on version.
+        run: |
+          V=${GITHUB_REF_NAME#v}
+          pip install "cocotb>=2.1,<2.2" pytest
+          for i in 1 2 3 4 5 6; do
+            pip install --no-deps --index-url https://test.pypi.org/simple/ \
+              "cocotbext-ryusim==$V" && break
+            sleep 20  # TestPyPI's index can lag the upload
+          done
+          python -c "import cocotbext.ryusim"
+      - name: Smoke tests against the installed artifact
+        # Remove the source tree so tests import the installed wheel, not ./src.
+        run: rm -rf src && pytest -v tests
+
+  pypi:
+    needs: verify
+    runs-on: ubuntu-24.04
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

cocotbext_ryusim-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+*.egg-info/
+dist/
+build/
+sim_build/
+results.xml
+*.vcd
+.pytest_cache/

cocotbext_ryusim-0.1.0/LICENSE

@@ -0,0 +1,30 @@
+Copyright cocotb contributors
+Copyright (c) 2013 Potential Ventures Ltd
+Copyright (c) 2013 SolarFlare Communications Inc
+Copyright (c) 2026 Seiraiyu
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cocotbext_ryusim-0.1.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.5
+Name: cocotbext-ryusim
+Version: 0.1.0
+Summary: RyuSim simulator support for cocotb
+Project-URL: Homepage, https://github.com/Seiraiyu/cocotbext-ryusim
+Project-URL: Issues, https://github.com/Seiraiyu/cocotbext-ryusim/issues
+Author: Seiraiyu
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Framework :: cocotb
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Requires-Python: >=3.9
+Requires-Dist: cocotb<2.2,>=2.1
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == 'test'
+Description-Content-Type: text/markdown
+
+# cocotbext-ryusim
+
+[RyuSim](https://ryusim.com) simulator support for [cocotb](https://www.cocotb.org).
+
+Adds `SIM=ryusim` to all three cocotb flows (Makefile, Python Runner and pytest)
+on stock, released cocotb. Pure Python: no fork of cocotb, no C++ toolchain, no
+compiled extension.
+
+## Requirements
+
+- cocotb **2.1.x**
+- Python 3.9+
+- Linux
+- RyuSim on `PATH`: `curl -fsSL https://ryusim.com/install.sh | bash`
+
+## Install
+
+```bash
+pip install cocotbext-ryusim
+```
+
+This installs a compatible cocotb alongside it.
+
+## Makefile flow
+
+Change one line in your testbench Makefile:
+
+```make
+# before
+include $(shell cocotb-config --makefiles)/Makefile.sim
+# after
+include $(shell cocotbext-ryusim-config --makefiles)/Makefile.sim
+```
+
+Then run `make SIM=ryusim`. Any other `SIM` value is passed to cocotb's own
+`Makefile.sim` unchanged, so the same Makefile still runs Icarus, Verilator and
+the other simulators.
+
+Standard cocotb variables work as usual (`COCOTB_TOPLEVEL`, `VERILOG_SOURCES`,
+`COCOTB_HDL_TIMEUNIT`, `WAVES=1` and so on). Set `RYUSIM_BIN_DIR` to use a
+`ryusim` that isn't on `PATH`. `make help` isn't available for `SIM=ryusim`.
+
+## Python Runner
+
+```python
+import cocotbext.ryusim  # registers "ryusim"
+from cocotb_tools.runner import get_runner
+
+runner = get_runner("ryusim")
+runner.build(sources=["dut.sv"], hdl_toplevel="dut", timescale=("1ns", "1ps"))
+runner.test(hdl_toplevel="dut", test_module="test_dut")
+```
+
+You can also construct `cocotbext.ryusim.RyuSim()` directly. `hdl_toplevel` is
+required, and `pre_cmd` is not supported.
+
+## pytest
+
+The plugin loads automatically once the package is installed. Select RyuSim
+explicitly:
+
+```bash
+pytest -p cocotb_tools._pytest.plugin --cocotb-simulator ryusim
+```
+
+With `--cocotb-simulator auto`, cocotb picks the first supported simulator it
+finds on `PATH`, and RyuSim comes last in that order. Pass `ryusim` explicitly
+if other simulators are also installed.
+
+## What RyuSim supports
+
+Verilog and SystemVerilog through VPI. There is no VHDL support.
+
+These parts of IEEE 1800-2023 are not implemented: switch-level modelling
+(clause 28; gate-level support covers the basic gate primitives only),
+user-defined primitives (29), `specify` blocks (30), timing checks (31), SDF
+back-annotation (32), design configurations (33), and the VPI assertion,
+coverage-control and data-read APIs (39–41).
+
+RyuSim rejects anything it doesn't implement at compile time, so an unsupported
+construct is always a compile error rather than a silent mis-simulation.
+
+Inertial writes are trusted by default (`COCOTB_TRUST_INERTIAL_WRITES=1`), as
+cocotb does for Verilator, GHDL and NVC.
+
+## How it works
+
+RyuSim's VPI callback behavior matches Verilator's, so this package loads
+cocotb's own `libcocotbvpi_verilator.so`. It adds `ryusim` to cocotb's runner and
+pytest registries, and ships the RyuSim makefile. It never modifies cocotb's
+installed files.
+
+## cocotb compatibility
+
+This package relies on some cocotb internals, so it pins `cocotb>=2.1,<2.2`. A
+new cocotb minor release gets a new cocotbext-ryusim release once CI passes
+against it. Until then, pip keeps a compatible cocotb rather than breaking at
+runtime. CI runs cocotb's full Verilog regression through this package.
+
+## License
+
+BSD-3-Clause. Portions are derived from cocotb, © cocotb contributors; see
+[LICENSE](LICENSE).

cocotbext_ryusim-0.1.0/README.md

@@ -0,0 +1,103 @@
+# cocotbext-ryusim
+
+[RyuSim](https://ryusim.com) simulator support for [cocotb](https://www.cocotb.org).
+
+Adds `SIM=ryusim` to all three cocotb flows (Makefile, Python Runner and pytest)
+on stock, released cocotb. Pure Python: no fork of cocotb, no C++ toolchain, no
+compiled extension.
+
+## Requirements
+
+- cocotb **2.1.x**
+- Python 3.9+
+- Linux
+- RyuSim on `PATH`: `curl -fsSL https://ryusim.com/install.sh | bash`
+
+## Install
+
+```bash
+pip install cocotbext-ryusim
+```
+
+This installs a compatible cocotb alongside it.
+
+## Makefile flow
+
+Change one line in your testbench Makefile:
+
+```make
+# before
+include $(shell cocotb-config --makefiles)/Makefile.sim
+# after
+include $(shell cocotbext-ryusim-config --makefiles)/Makefile.sim
+```
+
+Then run `make SIM=ryusim`. Any other `SIM` value is passed to cocotb's own
+`Makefile.sim` unchanged, so the same Makefile still runs Icarus, Verilator and
+the other simulators.
+
+Standard cocotb variables work as usual (`COCOTB_TOPLEVEL`, `VERILOG_SOURCES`,
+`COCOTB_HDL_TIMEUNIT`, `WAVES=1` and so on). Set `RYUSIM_BIN_DIR` to use a
+`ryusim` that isn't on `PATH`. `make help` isn't available for `SIM=ryusim`.
+
+## Python Runner
+
+```python
+import cocotbext.ryusim  # registers "ryusim"
+from cocotb_tools.runner import get_runner
+
+runner = get_runner("ryusim")
+runner.build(sources=["dut.sv"], hdl_toplevel="dut", timescale=("1ns", "1ps"))
+runner.test(hdl_toplevel="dut", test_module="test_dut")
+```
+
+You can also construct `cocotbext.ryusim.RyuSim()` directly. `hdl_toplevel` is
+required, and `pre_cmd` is not supported.
+
+## pytest
+
+The plugin loads automatically once the package is installed. Select RyuSim
+explicitly:
+
+```bash
+pytest -p cocotb_tools._pytest.plugin --cocotb-simulator ryusim
+```
+
+With `--cocotb-simulator auto`, cocotb picks the first supported simulator it
+finds on `PATH`, and RyuSim comes last in that order. Pass `ryusim` explicitly
+if other simulators are also installed.
+
+## What RyuSim supports
+
+Verilog and SystemVerilog through VPI. There is no VHDL support.
+
+These parts of IEEE 1800-2023 are not implemented: switch-level modelling
+(clause 28; gate-level support covers the basic gate primitives only),
+user-defined primitives (29), `specify` blocks (30), timing checks (31), SDF
+back-annotation (32), design configurations (33), and the VPI assertion,
+coverage-control and data-read APIs (39–41).
+
+RyuSim rejects anything it doesn't implement at compile time, so an unsupported
+construct is always a compile error rather than a silent mis-simulation.
+
+Inertial writes are trusted by default (`COCOTB_TRUST_INERTIAL_WRITES=1`), as
+cocotb does for Verilator, GHDL and NVC.
+
+## How it works
+
+RyuSim's VPI callback behavior matches Verilator's, so this package loads
+cocotb's own `libcocotbvpi_verilator.so`. It adds `ryusim` to cocotb's runner and
+pytest registries, and ships the RyuSim makefile. It never modifies cocotb's
+installed files.
+
+## cocotb compatibility
+
+This package relies on some cocotb internals, so it pins `cocotb>=2.1,<2.2`. A
+new cocotb minor release gets a new cocotbext-ryusim release once CI passes
+against it. Until then, pip keeps a compatible cocotb rather than breaking at
+runtime. CI runs cocotb's full Verilog regression through this package.
+
+## License
+
+BSD-3-Clause. Portions are derived from cocotb, © cocotb contributors; see
+[LICENSE](LICENSE).