-
Notifications
You must be signed in to change notification settings - Fork 0
Prepare repo for Phase 1 customer delivery #119
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.
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
Merged
Changes from 9 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
5ab6cd7
docs: add Phase 2 state estimation research to phase2-research/
619c314
docs: commit evaluation test outputs and observations
7385b1c
docs: add PyPSA latency benchmark results and test scripts
d420834
refactor: move top-level scripts/ to data/validation/
82f3983
refactor: remove internal artifacts and update .gitignore
d564f47
docs: track SOW proposal document
e70390a
docs: rewrite README for analyst audience and add directory guides
29a9736
docs: add Phase 1 white paper deliverable (SOW Task 1.3)
a173441
docs: condense white paper to ~2,500 words with report site references
0da9e4e
chore: gitignore SOW proposal document
c951ef8
fix: correct FNM description to Full Network Model
4d4226f
security: scrub real FNM identifiers from all tracked files
7958d90
fix: correct 6 factual errors in white paper and report site
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,139 +1,85 @@ | ||
| # GRC Tech Evaluation | ||
| # GRC Technology Evaluation — Phase 1 | ||
|
|
||
| **[View the Phase 1 Tool Selection Report](https://zgenergy.github.io/grc-tech-evaluation/)** | ||
| **[View the Interactive Report](https://zgenergy.github.io/grc-tech-evaluation/)** | ||
|
|
||
| Reproducible evaluation environments for six power-system modeling packages, | ||
| supporting the Phase 1 technology assessment. | ||
| Phase 1 technology evaluation comparing six open-source power-system modeling | ||
| tools against a six-criterion rubric. **PyPSA is the recommended tool for | ||
| Phase 2 development**, earning Strong in five of six criteria and holding the | ||
| top position across all sensitivity scenarios tested. | ||
|
|
||
| ## Tools Under Evaluation | ||
| | Tool | Language | Expressiveness | Extensibility | Scalability | Accessibility | Maturity | Supply Chain | | ||
| |------|----------|:-:|:-:|:-:|:-:|:-:|:-:| | ||
| | **PyPSA** | Python | Strong | Strong | Adequate | Strong | Strong | Strong | | ||
| | PowerModels.jl | Julia | Adequate | Strong | Adequate | Adequate | Adequate | Adequate | | ||
| | PowerSimulations.jl | Julia | Adequate | Strong | Adequate | Weak | Adequate | Adequate | | ||
| | GridCal | Python | Adequate | Adequate | Adequate | Weak | Weak | Strong | | ||
| | pandapower | Python | Weak | Adequate | Weak | Adequate | Strong | Strong | | ||
| | MATPOWER\* | MATLAB | Adequate | Strong | Weak | Adequate | Adequate | Strong | | ||
|
|
||
| | Tool | Language | Directory | | ||
| |------|----------|-----------| | ||
| | [PyPSA](https://pypsa.org/) | Python | `evaluations/pypsa/` | | ||
| | [pandapower](https://www.pandapower.org/) | Python | `evaluations/pandapower/` | | ||
| | [GridCal](https://www.advancedgridinsights.com/gridcal) | Python | `evaluations/gridcal/` | | ||
| | [PowerModels.jl](https://lanl-ansi.github.io/PowerModels.jl/) | Julia | `evaluations/powermodels/` | | ||
| | [PowerSimulations.jl](https://nrel-sienna.github.io/PowerSimulations.jl/) | Julia | `evaluations/powersimulations/` | | ||
| | [MATPOWER](https://matpower.org/) | MATLAB/Octave | `evaluations/matpower/` | | ||
| \*Reference benchmark only; excluded from ranking (requires MATLAB runtime). | ||
|
|
||
| ## Directory Structure | ||
| ## Repository Guide | ||
|
|
||
| ``` | ||
| grc-tech-evaluation/ | ||
| ├── evaluation_guides/ # Rubric and test protocol | ||
| │ ├── Phase1_Evaluation_Rubric_v1.md | ||
| │ └── Phase1_Test_Protocol_v2.md | ||
| ├── data/ | ||
| │ └── networks/ # Shared MATPOWER .m test cases | ||
| ├── evaluations/ | ||
| │ ├── pypsa/ # Independent uv project | ||
| │ ├── pandapower/ # Independent uv project | ||
| │ ├── gridcal/ # Independent uv project | ||
| │ ├── powermodels/ # Julia project | ||
| │ ├── powersimulations/ # Julia project | ||
| │ └── matpower/ # Octave + download script | ||
| └── README.md | ||
| ``` | ||
|
|
||
| ## Dev Environment | ||
|
|
||
| All six tools run inside a single **devcontainer** that ships Python 3.12, uv, | ||
| Julia 1.10, and GNU Octave with all dependencies pre-installed. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| | Requirement | Notes | | ||
| |-------------|-------| | ||
| | [Docker](https://docs.docker.com/get-docker/) | Docker Desktop or Docker Engine | | ||
| | [VS Code](https://code.visualstudio.com/) + [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) | Recommended for interactive development | | ||
| | *or* [devcontainer CLI](https://github.com/devcontainers/cli) | `npm install -g @devcontainers/cli` — for headless/CI use | | ||
|
|
||
| ### Building and Opening the Container | ||
|
|
||
| **VS Code (recommended):** | ||
| ### For Analysts | ||
|
|
||
| 1. Open this repo in VS Code. | ||
| 2. When prompted, click **Reopen in Container** (or run the command | ||
| `Dev Containers: Reopen in Container` from the palette). | ||
| 3. The first build takes a few minutes while it installs all runtimes and | ||
| dependencies. Subsequent opens reuse the cached image and start in seconds. | ||
| | Directory | Contents | | ||
| |-----------|----------| | ||
| | [`report/`](report/) | Interactive Docusaurus report site — the primary deliverable | | ||
| | [`deliverables/`](deliverables/) | Formal white paper (SOW Task 1.3) | | ||
| | [`evaluations/`](evaluations/) | Per-tool evaluation evidence, test code, and results | | ||
| | [`evaluation_guides/`](evaluation_guides/) | Rubric and test protocol defining all 39 tests | | ||
| | [`data/`](data/) | Shared test networks (MATPOWER cases), augmented time series, FNM data | | ||
| | [`phase2-research/`](phase2-research/) | State estimation investigation (Phase 2 groundwork) | | ||
|
|
||
| **CLI:** | ||
| ### For Developers | ||
|
|
||
| ```bash | ||
| # Build and start the container (first time or after Dockerfile changes) | ||
| devcontainer up --workspace-folder . | ||
|
|
||
| # Open an interactive shell inside the running container | ||
| devcontainer exec --workspace-folder . bash | ||
| | Directory | Contents | | ||
| |-----------|----------| | ||
| | `.devcontainer/` | Docker development environment (Python 3.12, Julia 1.10, Octave) | | ||
| | `.github/` | CI/CD workflows | | ||
| | `data/validation/` | Data quality scripts (schema validation, manifest generation) | | ||
|
|
||
| # Or run a one-off command | ||
| devcontainer exec --workspace-folder . uv run --project evaluations/pypsa python -c "import pypsa; print(pypsa.__version__)" | ||
| ``` | ||
|
|
||
| ### What's Inside the Image | ||
| ## Tools Evaluated | ||
|
|
||
| The Dockerfile (`.devcontainer/Dockerfile`) installs everything at build time | ||
| so the container is ready to use immediately: | ||
| Each tool has an independent environment under `evaluations/<tool>/`: | ||
|
|
||
| - **Python 3.12** + **uv** — each Python tool (`pypsa`, `pandapower`, | ||
| `gridcal`) has its own `.venv` created by `uv sync` during the build. | ||
| - **Julia 1.10.7** (pinned LTS) — Julia packages for `powermodels` and | ||
| `powersimulations` are instantiated and precompiled during the build. | ||
| - **GNU Octave** — MATPOWER 8.1 is downloaded by `setup.sh` during the build. | ||
| ### Verifying the Install | ||
| | Tool | Language | Environment | | ||
| |------|----------|-------------| | ||
| | [PyPSA](https://pypsa.org/) | Python | `uv sync` | | ||
| | [pandapower](https://www.pandapower.org/) | Python | `uv sync` | | ||
| | [GridCal](https://www.advancedgridinsights.com/gridcal) | Python | `uv sync` | | ||
| | [PowerModels.jl](https://lanl-ansi.github.io/PowerModels.jl/) | Julia | `Pkg.instantiate()` | | ||
| | [PowerSimulations.jl](https://nrel-sienna.github.io/PowerSimulations.jl/) | Julia | `Pkg.instantiate()` | | ||
| | [MATPOWER](https://matpower.org/) | MATLAB/Octave | `bash setup.sh` | | ||
|
|
||
| Smoke-test all six tools at once: | ||
|
|
||
| ```bash | ||
| bash .devcontainer/validate.sh | ||
| ``` | ||
| ## Evaluation Protocol | ||
|
|
||
| Or verify a single tool: | ||
| The evaluation uses a standardized rubric and test protocol: | ||
|
|
||
| ```bash | ||
| # Python tools (pypsa, pandapower, gridcal) | ||
| cd evaluations/<tool> && uv run python verify_install.py | ||
| - **[Phase1_Evaluation_Rubric.md](evaluation_guides/Phase1_Evaluation_Rubric.md)** — | ||
| Scoring criteria across six dimensions with tier definitions | ||
| - **[Phase1_Test_Protocol.md](evaluation_guides/Phase1_Test_Protocol.md)** — | ||
| 39 specific tests with acceptance criteria | ||
|
|
||
| # Julia tools (powermodels, powersimulations) | ||
| cd evaluations/<tool> && julia --project=. verify_install.jl | ||
| Test networks: IEEE 39-bus, ACTIVSg 2,000-bus, and ACTIVSg 10,000-bus | ||
| synthetic cases from `data/networks/`. | ||
|
|
||
| # MATPOWER | ||
| cd evaluations/matpower && octave verify_install.m | ||
| ``` | ||
| Results for each tool are in `evaluations/<tool>/results/` organized by rubric | ||
| dimension, with a `synthesis.md` summarizing findings. | ||
|
|
||
| ### Day-to-Day Development | ||
| ## Development Environment | ||
|
|
||
| All work happens inside the container. Run scripts with the tool's own runtime: | ||
| All tools run inside a single devcontainer. See | ||
| [`.devcontainer/`](.devcontainer/) for setup instructions. | ||
|
|
||
| ```bash | ||
| # Run a Python evaluation script | ||
| cd evaluations/pypsa | ||
| uv run python results/gate/ac_power_flow.py | ||
|
|
||
| # Run a Julia evaluation script | ||
| cd evaluations/powermodels | ||
| julia --project=. results/gate/ac_power_flow.jl | ||
| # Build and open | ||
| devcontainer up --workspace-folder . | ||
| devcontainer exec --workspace-folder . bash | ||
|
|
||
| # Run an Octave evaluation script | ||
| cd evaluations/matpower | ||
| octave results/gate/ac_power_flow.m | ||
| # Verify all tools | ||
| bash .devcontainer/validate.sh | ||
|
|
||
| # Lint Python files | ||
| # Lint | ||
| pre-commit run --all-files | ||
| ``` | ||
|
|
||
| If you need to add a Python dependency to a tool, update its `pyproject.toml` | ||
| and run `uv sync` inside that tool's directory — do not use `pip install`. | ||
| For Julia, edit `Project.toml` and run | ||
| `julia --project=. -e 'using Pkg; Pkg.instantiate()'`. | ||
|
|
||
| ## Evaluation Protocol | ||
|
|
||
| See `evaluation_guides/` for the full rubric and test protocol: | ||
|
|
||
| - **Phase1_Evaluation_Rubric_v1.md** — Scoring criteria across seven dimensions | ||
| - **Phase1_Test_Protocol_v2.md** — Specific tests and acceptance criteria | ||
|
|
||
| Results for each tool are organized into subdirectories under | ||
| `evaluations/<tool>/results/` matching the rubric dimensions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # Data | ||
|
|
||
| Shared test data consumed by all six evaluation environments. | ||
|
|
||
| ## Directory Structure | ||
|
|
||
| | Directory | Contents | | ||
| |-----------|----------| | ||
| | `networks/` | MATPOWER `.m` case files (IEEE 39-bus, ACTIVSg 2k, ACTIVSg 10k) | | ||
| | `fnm/` | Foundational Network Model — parsed hydro network data with intermediate schemas | | ||
| | `timeseries/` | Augmented time-series data (load profiles, gen costs, reserves, scenarios) | | ||
| | `reference/` | Reference data (RTS-GMLC technology classes, calibration outputs) | | ||
| | `scripts/` | Data augmentation pipeline (generates timeseries/ and reference/ outputs) | | ||
| | `validation/` | Data quality scripts (schema validation, manifest generation, doc generation) | | ||
| | `whitepaper_proposal.md` | SOW contract proposal document | | ||
|
|
||
| ## Data Flow | ||
|
|
||
| ``` | ||
| networks/ (raw MATPOWER cases) | ||
| │ | ||
| ├── scripts/ (augmentation pipeline) ──→ timeseries/ + reference/ | ||
| │ | ||
| └── fnm/ (parsed network model) ──→ fnm/reference/ (cleaned data + DCPF solutions) | ||
| ``` | ||
|
|
||
| The `Makefile` orchestrates the augmentation pipeline stages in dependency order. | ||
|
|
||
| ## Important | ||
|
|
||
| `networks/` and `timeseries/` paths are hard-coded in evaluation test suites | ||
| across all six tools. **Do not move or rename these directories.** | ||
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
full network model.