ChipFlow Training

Training materials for learning the ChipFlow platform — a cloud-based RTL-to-GDS chip design service.

What's included

• Creating a Design for Use with the ChipFlow Platform — how to create a new design from scratch for the ChipFlow platform
• Upcounter example — a simple Amaranth HDL design targeting the IHP SG13G2 130nm process, ready to build and submit to the platform
• Training Command Reference — step-by-step guide covering prerequisites, setup, authentication, building, and submitting designs
• chipflow.toml Reference — complete configuration format documentation
• Simulation — testing designs locally with CXXRTL-based simulation
• Upcounter Simulation Walkthrough — step-by-step guide to simulating the upcounter with waveforms

Quick start

# Clone this repo
git clone https://github.com/ChipFlow/chipflow-training.git
cd chipflow-training

# Install dependencies
make init

# Build and submit the upcounter design
make upcounter-submit

See the Training Command Reference for detailed instructions including prerequisites for macOS, Linux, and Windows.

Project structure

chipflow-training/
├── Makefile                    # Build commands
├── pyproject.toml              # Python dependencies
├── getting-started-design.md   # How to write a new design
├── training-commands.md        # Full training guide
├── chipflow-toml-reference.md  # Configuration reference
├── simulation.md               # Simulation guide
└── upcounter/
    ├── chipflow.toml           # Design config (process, package)
    └── design/
        └── design.py           # Amaranth HDL upcounter design

Links

• ChipFlow Platform
• chipflow-lib — core client library
• chipflow-examples — additional example designs