Entorno de desarrollo

Clonar el repositorio e instalarlo en modo editable (recomendado)

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

Habilita el entorno Nix ejecutando el siguiente comando:

nix develop .

Esto creará una shell con todas las dependencias necesarias y un directorio .venv con el entorno de Python.

Guía de estilo

EvoX tiene la siguiente guía de estilo:

1. Asegúrate de usar ruff para realizar el linting de tu código.
2. Asegúrate de que no haya espacios en blanco al final de las líneas (trailing whitespaces).

Pre-commit

Recomendamos usar pre-commit para aplicar la guía de estilo. Después de instalar pre-commit, ejecuta el siguiente comando para instalar los hooks en tu repositorio local:

pre-commit install

Ejecutar pruebas unitarias

1. prepara el entorno de pruebas instalando los paquetes requeridos (por ejemplo, torch) en tu entorno de Python
2. ejecuta 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]