Skip to main content

GAT - Grid Analysis Toolkit

tests lint code style: black docs PyPI Python License

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-gat because gat on PyPI is an unrelated genomics package. The import package and CLI are still gat, which also means nlr-gat cannot 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):

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…". See gridsight-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's scripts/setup-extensions.sh does 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.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nlr-gat 0.1.4
File Size Uploaded Provenance Actions
nlr_gat-0.1.4.tar.gz 771.2 kB With provenance Details for nlr_gat-0.1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nlr-gat 0.1.4
File Interpreter ABI Platform Actions
nlr_gat-0.1.4-py3-none-any.whl Python 3 none any Details for nlr_gat-0.1.4-py3-none-any.whl

Total release size: 1.1 MB

Release files / nlr_gat-0.1.4.tar.gz

Download URL nlr_gat-0.1.4.tar.gz
Size 771.2 kB
Tags Source
SHA-256 checksum
How to use checksums
7264a98d56de401699dd1487d1ac7159e43b1ab47c50cc5ecd3ed9c6e871ed9b
BLAKE2b-256 checksum
How to use checksums
7073942001df72d9f68dd8d3844b3d455353b812b44a2be348a7da3f27d08e4a
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 log

Release files / nlr_gat-0.1.4-py3-none-any.whl

Download URL nlr_gat-0.1.4-py3-none-any.whl
Size 282.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
43639cedc6048ff905260da505b1cbc035838a28f9ca5a8ce0e6bae4f4218ccd
BLAKE2b-256 checksum
How to use checksums
17899c1dc105d03205cc26c419e80f5316a6c5c01dfe391ebf82990b9b591e43
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 log

Security for nlr-gat 0.1.4

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.

Select from 2 files

Attestation for nlr_gat-0.1.4.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 log

A 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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page