はじめる

前提条件

• Node.js（v18 以上）
• パッケージマネージャ（npm、pnpm、yarn など）
• Rust ツールチェーン -- プラットフォーム向けのプリビルドネイティブアドオンがない場合に必要

スターターテンプレート

すぐに使えるプロジェクトテンプレートが celox-template にあります。GitHub で Use this template をクリックするかリポジトリをクローンして、npm install && npm test を実行すればすぐに始められます。

プロジェクトのセットアップ

新しいプロジェクトディレクトリを作成して初期化します：

mkdir my-celox-project && cd my-celox-project
npm init -y
npm pkg set type=module

Celox と Vitest をインストールします：

npm add -D @celox-sim/celox @celox-sim/vite-plugin vitest

以下の手順を完了すると、プロジェクト構成は次のようになります：

my-celox-project/
├── Veryl.toml            # Veryl プロジェクト設定
├── vitest.config.ts      # Vitest + Celox プラグイン
├── tsconfig.json
├── package.json
├── src/
│   └── Adder.veryl       # Veryl 設計ファイル
└── test/
    └── adder.test.ts     # TypeScript テストベンチ

Veryl.toml

プロジェクトルートに Veryl.toml を作成します：

[project]
name    = "my_project"
version = "0.1.0"

[build]
clock_type = "posedge"
reset_type = "async_low"
sources    = ["src"]

vitest.config.ts

import { defineConfig } from "vitest/config";
import celox from "@celox-sim/vite-plugin";

export default defineConfig({
  plugins: [celox()],
});

tsconfig.json

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ES2022",
    "moduleResolution": "bundler",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "allowArbitraryExtensions": true,
    "rootDirs": ["src", ".celox/src"]
  },
  "include": ["test", "src", ".celox/src"]
}

Veryl モジュールを書く

src/Adder.veryl を作成します：

module Adder (
    clk: input clock,
    rst: input reset,
    a: input logic<16>,
    b: input logic<16>,
    sum: output logic<17>,
) {
    always_comb {
        sum = a + b;
    }
}

テストを書く

test/adder.test.ts を作成します：

import { describe, test, expect } from "vitest";
import { Simulator } from "@celox-sim/celox";
import { Adder } from "../src/Adder.veryl";

describe("Adder", () => {
  test("adds two numbers", () => {
    const sim = Simulator.create(Adder);

    sim.dut.a = 100n;
    sim.dut.b = 200n;
    expect(sim.dut.sum).toBe(300n);

    sim.dispose();
  });
});

Vite プラグインが .veryl ファイルを自動的に解析して TypeScript の型定義を生成するため、import { Adder } from "../src/Adder.veryl" のインポートは完全に型付けされます。

テストを実行する

package.json にテストスクリプトを追加します：

{
  "scripts": {
    "test": "vitest run"
  }
}

実行します：

npm test

次のステップ

• テストの書き方 -- イベントベースとタイムベースのシミュレーションパターン。
• はじめに -- アーキテクチャの概要。