開発環境

リポジトリのクローンと編集可能モードでのインストール（推奨）

git clone https://github.com/EMI-Group/evox.git
cd evox
pip install -e ".[test]" # install the package in editable mode with test dependencies

Nix

以下のコマンドを実行して、Nix 環境を有効にします。

nix develop .

これにより、必要なすべての依存関係を含むシェルと、Python 環境を含む .venv ディレクトリが作成されます。

スタイルガイド

EvoX には以下のスタイルガイドがあります。

コードの lint には必ず ruff を使用してください。
行末に余分な空白（trailing whitespaces）がないことを確認してください。

Pre-commit

スタイルガイドを強制するために、pre-commit の使用を推奨します。 pre-commit をインストールした後、以下のコマンドを実行してローカルリポジトリにフックをインストールしてください。

pre-commit install

ユニットテストの実行

Python 環境に必要なパッケージ（torch など）をインストールして、テスト環境を準備します。
unittest を実行します。

# run all tests
python -m unittest
# run tests in [path], e.g. python -m unittest unit_test/core/test_jit_util.py
python -m unittest [path-to-test-file]
# run a specific test method or module, e.g. python -m unittest unit_test.core.test_jit_util.TestJitUtil.test_single_eval
python -m unittest [path-to-method-or-module]