Среда разработки

Клонирование репозитория и установка в режиме редактирования (рекомендуется)

git clone https://github.com/EMI-Group/evox.git
cd evox
pip install -e ".[test]" # установка пакета в режиме редактирования с тестовыми зависимостями

Nix

Активируйте окружение Nix, выполнив следующую команду:

nix develop .

Это создаст оболочку со всеми необходимыми зависимостями и каталог .venv с окружением Python.

Руководство по стилю

EvoX имеет следующее руководство по стилю:

Убедитесь, что используете ruff для проверки кода.
Убедитесь, что нет завершающих пробелов.

Pre-commit

Мы рекомендуем использовать pre-commit для соблюдения руководства по стилю. После установки pre-commit выполните следующую команду для установки хуков в вашем локальном репозитории:

pre-commit install

Запуск модульных тестов

Подготовьте тестовое окружение, установив необходимые пакеты (например, torch) в вашем окружении Python
Запустите unittest:

# запуск всех тестов
python -m unittest
# запуск тестов в [path], например python -m unittest unit_test/core/test_jit_util.py
python -m unittest [path-to-test-file]
# запуск конкретного тестового метода или модуля, например python -m unittest unit_test.core.test_jit_util.TestJitUtil.test_single_eval
python -m unittest [path-to-method-or-module]