Skip to content

docs: add devcontainer script execution instructions #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joeshull merged 1 commit into from
Apr 8, 2026
Merged

docs: add devcontainer script execution instructions #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,25 @@ bash .devcontainer/validate.sh
# Lint
pre-commit run --all-files
```

### Running evaluation scripts

Each tool has its own virtualenv — **do not use bare `python`** from the
container shell, as it points to the system Python which has no packages
installed. Always `cd` into the tool directory and use `uv run` (Python tools)
or `julia --project=.` (Julia tools):

```bash
# Python tools (pypsa, pandapower, gridcal)
cd /workspace/evaluations/pypsa
uv run python tests/expressiveness/test_a1_dcpf.py
uv run pytest tests/ # run full test suite

# Julia tools (powermodels, powersimulations)
cd /workspace/evaluations/powermodels
julia --project=. tests/runtests.jl

# MATPOWER (Octave)
cd /workspace/evaluations/matpower
octave tests/run_tests.m
```
Loading