GAT - Grid Analysis Toolkit
A toolkit for wrangling data for Bulk Grid Dispatch and Transmission Analysis.
GAT aims to provide simplified access to PCM and CEM results in a standard format while also allowing raw data access to underlying datasets specific to the model.
For plotting, GAT defaults to standard National Lab of the Rockies (NLR) color schemes and standard styles while allowing customization.
Installation
It is recommended to create a virtual environment for installing GAT.
In your desired directory, run one of the following.
python -m venv .venv
python3 -m venv .venv
Then activate your virtual environment by running.
. .venv/bin/activate on MacOS or Linux
or .venv/Scripts/Activate on Windows. If you are having trouble activating the virtual environment on Windows, you may need to update your execution policy. More can be read here.
Install the latest release from PyPI:
pip install nlr-gat
Note: the distribution is named
nlr-gatbecausegaton PyPI is an unrelated genomics package. The import package and CLI are stillgat, which also meansnlr-gatcannot share an environment with that genomics package.
Choosing extras
The bare install above pulls in only the format-agnostic core — no scenario handler is usable yet. Each simulation/model format has its own extra, so you only install the (often large, native-code) dependencies you actually need:
| Extra | Adds | Installs |
|---|---|---|
sienna |
SiennaScenario |
h5py, polars, geopandas |
plexos |
PlexosScenario (both backends, for now — see the H5PLEXOS.jl deprecation notice above) |
h5py, duckdb, plexos2duckdb |
reeds |
ReEDsScenario |
(base deps only) |
plots |
gat.quickplots / the .plot property on any scenario |
matplotlib (+ PySide6 on macOS) |
server |
gat.server (the data server) |
fastapi, uvicorn, duckdb, pyarrow |
client |
gat.client (remote scenario access) |
httpx, pyarrow |
all |
everything above | — |
Combine as needed, e.g.:
pip install "nlr-gat[sienna,plots]"
pip install "nlr-gat[plexos,server]"
pip install "nlr-gat[all]"
Or install from GitHub — the latest, a specific release, or a branch:
pip install git+https://github.com/NatLabRockies/GridAnalysisToolkit
pip install git+https://github.com/NatLabRockies/GridAnalysisToolkit@v0.1.0
pip install git+https://github.com/NatLabRockies/GridAnalysisToolkit@{branch_name}
Documentation
The latest stable documentation lives at natlabrockies.github.io/GridAnalysisToolkit. The example gallery is a good starting point for visual capability.
Highest-traffic doc pages (also readable directly in the repo):
- Quickstart: scenarios and palettes
- Python API:
gat.load(...) - Sienna scaling and raw dataset access
- Custom plots and the reporting framework
- v1 architecture & migration pattern
- Legacy scenario handler deprecation
- Migrating from v0.x to v1.0
- Changelog
Use with GridSight
GridSight can show GAT
scenarios as map layers, charts and animated timeseries. The extension
lives in gridsight-ext/ (package gridsight-gat).
- GridSight desktop: build the side-load bundle with
make gridsight-bundle, then pick the zip in GridSight → Settings → "Choose wheel…". Seegridsight-ext/BUILDING.md. - GridSight from source or Docker: install both packages into the
GridSight server environment:
pip install "nlr-gat[sienna,server]" "gridsight-gat @ git+https://github.com/NatLabRockies/GridAnalysisToolkit.git#subdirectory=gridsight-ext". GridSight'sscripts/setup-extensions.shdoes this for a sibling clone.
Example data
example_data/ is gitignored — the binaries are too large to track
in-tree. Sienna fixtures regenerate via make sienna-fixture-v4
(requires Docker; see docker/sienna/README.md). For Plexos (pip install nlr-gat[plexos]), point the GAT_PLEXOS_FIXTURE environment
variable at a directory of .h5 solution files of your own, or
GAT_PLEXOS_ZIP_FIXTURE at a native PLEXOS Solution.zip.
Contributing
If you wish to contribute to the development of GAT, please clone the repo and install the dev dependencies as follows.
git clone https://github.com/NatLabRockies/GridAnalysisToolkit.git
cd GridAnalysisToolkit
Follow the instructions for creating a virtual environment above, then:
pip install -e ".[dev]"
When you are ready, please open a pull request for review.
If you plan to contribute to documentation, install the documentation dependencies as well.
pip install -e ".[dev,doc]"
Commit messages and PR titles should follow Conventional Commits
(feat: ..., fix: ..., docs: ..., etc.) — releases are generated
automatically from these (see .github/workflows/release.yml).
Building the documentation
After installing the doc dependencies:
cd docs && sphinx-build -b html source build/html
Review documentation changes locally:
open build/html/index.html
Software Record and Disclaimer
GAT is developed by the National Lab of the Rockies (NLR) and released under software record SWR-25-41 "GAT (Grid Analysis Toolkit)".
See DISCLAIMER.md for the full disclaimer.
Metadata
Release files for nlr-gat 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nlr_gat-0.1.3.tar.gz | 769.6 kB | With provenance | Details for nlr_gat-0.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nlr_gat-0.1.3-py3-none-any.whl | Python 3 | none | any | Details for nlr_gat-0.1.3-py3-none-any.whl |
Total release size: 1.1 MB
Release files / nlr_gat-0.1.3.tar.gz
| Download URL | nlr_gat-0.1.3.tar.gz |
|---|---|
| Size | 769.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6751239c2a050cf2e967d47ffeb46b90a4e9102bcfc69d56a70160a1f8cd42c5
|
|
BLAKE2b-256 checksum How to use checksums |
ed4b1755764ad0c666833c7331ad7a2445d0de619860663c262ed6ae15af0a80
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.
Transparency logRelease files / nlr_gat-0.1.3-py3-none-any.whl
| Download URL | nlr_gat-0.1.3-py3-none-any.whl |
|---|---|
| Size | 282.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0359034c3ce78b23750fae67a19d90178c166fa92d0090210b81bc7fe4f13d56
|
|
BLAKE2b-256 checksum How to use checksums |
5412a5753703614536385e0ad136f011c163aa8b6fe2ba7b7e89cad7dcaaae80
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.
Transparency logSecurity for nlr-gat 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for nlr_gat-0.1.3.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.