ComoPy: Co-modeling Tools for Hardware Generation with Python

ComoPy (Co-modeling tools in Python) is a Python-based Hardware Generation, Simulation, and Debugging Framework (HGSDF) that enables hardware development with the same ease and flexibility as software development.

Development Setup

Prerequisites

• Python 3.10+
• pip (Python package installer)

Install Dependencies

To set up the development environment, install the required dependencies:

# Install core dependencies.
pip install -e .

# Install dependencies for cocotb extension.
pip install -e ".[cocotb]"

# Install development dependencies (for testing).
pip install -e ".[dev]"

Verilator is required for VSimulator and checkpoint. This has been tested with Verilator 5.040.

# Verify the installation.
verilator --version

Icarus Verilog is used for testing the cocotb extension but is not a runtime dependency. This has been tested with iverilog v13_0.

# Verify the installation.
iverilog -v

Install Pre-commit Hooks

If you plan to contribute to the project, install pre-commit hooks to automatically check code quality before commits:

# Install pre-commit
pip install pre-commit

# Install the git hooks
pre-commit install

Run Tests

After installing the development dependencies, you can run the test suite using pytest:

# Run all tests
pytest

# Run tests with coverage report
pytest --cov=comopy

# Run tests with HTML coverage report
pytest --cov=comopy --cov-report=html

# Run tests in verbose mode
pytest -v

# Run specific test file
pytest comopy/tests/test_specific.py

The conftest.py provides a comopy_path fixture for test paths. For complex directory structures, configure additional paths in pytest.ini.