ChipFlow Project

Welcome to your ChipFlow hardware design project! This repository was generated from the ChipFlow Configurator and contains everything you need to simulate and verify your chip design.

Getting Started in Codespaces

Your development environment is ready to use! Here's how to get started:

1. Build Your Design

chipflow sim build

This command:

• Generates Verilog from your chip configuration
• Compiles the simulation executable
• Prepares everything for running simulations

2. Run Simulations

chipflow sim run

This will execute your design simulation and show the results.

3. View Results

After simulation, you can explore the generated files:

• Verilog sources: Check the generated RTL code
• Waveforms: View signal traces (if waveform dumping is enabled)
• Test results: See simulation output and verification results

Need Help?

• ChipFlow Documentation: docs.chipflow.io
• Report Issues: github.com/ChipFlow/chipflow-template/issues
• Configurator: configurator.chipflow.io

---

Developer Documentation

Project Structure

.
├── .devcontainer/       # Codespace/devcontainer configuration
├── designs/             # Generated chip designs (created after build)
├── pyproject.toml       # Python dependencies
├── pdm.lock            # Locked dependency versions
└── README.md           # This file

ChipFlow Commands

Command	Description
chipflow sim build	Build the simulation from your design configuration
chipflow sim run	Run the compiled simulation
chipflow pin lock	Lock pin assignments for your design

Development Workflow

1. Modify Design: Update your chip configuration through the configurator or directly edit design files
2. Build: Run chipflow sim build to regenerate Verilog and compile
3. Simulate: Run chipflow sim run to test your changes
4. Iterate: Review results and repeat

Environment Details

This devcontainer includes:

• Python 3.x with PDM package manager
• ChipFlow toolchain for hardware design
• Yosys (via yowasp-yosys) for synthesis
• Zig for compilation
• Pre-warmed caches for fast startup

Testing Locally

If you want to test the devcontainer locally with VS Code or other Docker-compatible tools:

# The devcontainer should work with any tool supporting the devcontainer spec
code .  # Opens in VS Code with devcontainer support

Contributing

This is a template repository. If you find issues with the devcontainer setup or have suggestions:

1. Visit ChipFlow/chipflow-template
2. Open an issue or pull request

---

Generated with ChipFlow - configurator.chipflow.io