EVO X

Entwicklungsumgebung

Entwicklungsumgebung

Repository klonen und im editierbaren Modus installieren (empfohlen)

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

Aktivieren Sie die Nix-Umgebung mit folgendem Befehl:

nix develop .

Dies erstellt eine Shell mit allen notwendigen Abhängigkeiten und ein .venv-Verzeichnis mit der Python-Umgebung.

Stilrichtlinien

EvoX hat die folgenden Stilrichtlinien:

  1. Stellen Sie sicher, dass Sie ruff verwenden, um Ihren Code zu linten.
  2. Stellen Sie sicher, dass keine nachgestellten Leerzeichen vorhanden sind.

Pre-commit

Wir empfehlen die Verwendung von pre-commit, um die Stilrichtlinien durchzusetzen. Nach der Installation von pre-commit führen Sie den folgenden Befehl aus, um die Hooks in Ihrem lokalen Repository zu installieren:

pre-commit install

Unit-Tests ausführen

  1. Bereiten Sie die Testumgebung vor, indem Sie die erforderlichen Pakete (z.B. torch) in Ihrer Python-Umgebung installieren
  2. Führen Sie unittest aus:
# 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]
← Zurück zur Dokumentation