A production-ready, containerized solution for evaluating hardware designs described in Verilog/SystemVerilog using Verilator and OpenLane. Built for ChipForge-SN84, it enables automated simulation and validation workflows. This guide helps validators and miners quickly set up, test, and operate the server from both the terminal and the GUI.

• Integrated EDA Tools: Verilator (simulation) and OpenLane (area, performance, and soon power evaluation)
• Evaluation Metrics: Functionality, area, performance, and (coming soon) power
• File Management: Direct upload, automatic parsing, ZIP archival

chipforge_eda_server/ ├── .env.example ├── Makefile ├── README.md ├── docker-compose.yml ├── example_usage.py ├── gateway/ │ ├── Dockerfile │ ├── main.py │ ├── requirements.txt │ └── evaluator/ │ ├── evaluator.py │ ├── evaluator.txt │ └── evaluator.zip ├── test_designs/ │ ├── adder.zip │ └── adder_evaluator.zip ├── verilator-api/ │ ├── Dockerfile │ ├── main.py │ └── requirements.txt ├── openlane-api/ │ ├── Dockerfile │ ├── main.py │ └── requirements.txt

1. Prerequisites: Docker, Docker Compose, Python 3.8+, 8GB+ RAM, 20GB+ disk.

2. Clone & Setup:

   git clone https://github.com/TatsuProject/chipforge_eda_server cd chipforge_eda_server cp .env.example .env # Edit .env if needed

3. Build Docker Images:

   make build # If this fails (sometimes due to internet speed), just run 'make build' again until it succeeds

4. Run Test from Terminal:

   make test # This will build, start all services, and run the validator script (example_usage.py)

• Build Docker images:

  make build

• Start all services (if already built):

  make up

• Build and start all services together:

  make start

• Run the validator script (if services are already running):

  python3 example_usage.py

• Check health:

  make health

• View logs:

  make logs

• After running make start, open your browser and go to http://localhost:8080/docs
• In the GUI, for /evaluate, click "Browse..." and select both your design ZIP (test_designs/adder.zip) and evaluator ZIP (test_designs/adder_evaluator.zip)
• Click "Execute" to run the evaluation and see results below

• make build — Build all Docker images
• make up — Start all services
• make start — Build and start all services together
• make test — Build, start, and run the validator script (all-in-one)
• make health — Check API health
• make logs — View logs
• make down — Stop all services
• make clean — Remove containers and prune system
• make restart-gateway — Restart only the gateway service
• build-gateway — Build only the gateway service
• build-verilator — Build only the verilator-api service

• Gateway Docs: http://localhost:8080/docs
• Main Evaluation Endpoint: POST /evaluate with ZIP files
• Verilator API: Accessible at http://localhost:8001
• OpenLane API: Accessible at http://localhost:8003

# example_usage.py (run with: make test) import os import requests BASE_URL = os.getenv("EDA_BASE_URL", "http://localhost:8080") design_zip = "test_designs/adder.zip" evaluator_zip = "test_designs/adder_evaluator.zip" with open(design_zip, "rb") as d, open(evaluator_zip, "rb") as e: files = { "design_zip": (os.path.basename(design_zip), d, "application/zip"), "evaluator_zip": (os.path.basename(evaluator_zip), e, "application/zip") } resp = requests.post(f"{BASE_URL}/evaluate", files=files) print(resp.json() if resp.ok else resp.text)

• Run make test to verify simulation from the terminal.
• Use the GUI (http://localhost:8080/docs) for interactive testing.

• Health: /health, /metrics, /status
• Logging: JSON, ELK stack, Sentry
• Use make logs, and check .env for issues.
• See docs for common errors and solutions.

• Verilator, OpenLane, and all contributors.

MIT License—see LICENSE.

• Discord
• Email: contact@tatsuecosystem.io

Ready to revolutionize hardware design evaluation! Built with ❤️ for the hardware design community