Environnement de développement

Cloner le dépôt et l’installer en mode éditable (recommandé)

git clone https://github.com/EMI-Group/evox.git
cd evox
pip install -e ".[test]" # installer le paquet en mode éditable avec les dépendances de test

Nix

Activez l’environnement Nix en exécutant la commande suivante :

nix develop .

Cela créera un shell avec toutes les dépendances nécessaires et un répertoire .venv avec l’environnement Python.

Guide de style

EvoX a le guide de style suivant :

1. Assurez-vous d’utiliser ruff pour vérifier votre code.
2. Assurez-vous qu’il n’y a pas d’espaces en fin de ligne.

Pre-commit

Nous recommandons d’utiliser pre-commit pour appliquer le guide de style. Après avoir installé pre-commit, exécutez la commande suivante pour installer les hooks dans votre dépôt local :

pre-commit install

Exécuter les tests unitaires

1. Préparez l’environnement de test en installant les paquets requis (par exemple torch) dans votre environnement Python
2. Exécutez les tests unitaires :

# exécuter tous les tests
python -m unittest
# exécuter les tests dans [chemin], par exemple python -m unittest unit_test/core/test_jit_util.py
python -m unittest [path-to-test-file]
# exécuter une méthode ou un module de test spécifique, par exemple python -m unittest unit_test.core.test_jit_util.TestJitUtil.test_single_eval
python -m unittest [path-to-method-or-module]