Metadata-Version: 2.4
Name: nlr-gat
Version: 0.1.0
Summary: Grid Analysis Toolkit - A module for PCM/CEM data analysis.
Author-email: Micah Webb <micah.webb@nlr.gov>
License: BSD 3-Clause License
        
        Copyright (c) 2026, Alliance for Energy Innovation, LLC
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/NatLabRockies/GridAnalysisToolkit
Project-URL: Bug Tracker, https://github.com/NatLabRockies/GridAnalysisToolkit/issues
Project-URL: Documentation, https://natlabrockies.github.io/GridAnalysisToolkit/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas>=2.1.0
Requires-Dist: h5py
Requires-Dist: tables
Requires-Dist: matplotlib
Requires-Dist: pydantic
Requires-Dist: click>=8.1.0
Requires-Dist: loguru>=0.7.3
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: geopandas>=1.1.1
Requires-Dist: duckdb>=1.4.0
Requires-Dist: polars>=1.0
Requires-Dist: orjson>=3.9.0
Requires-Dist: pyarrow>=14.0
Requires-Dist: PySide6; sys_platform == "darwin"
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-regressions>=2.5; extra == "dev"
Requires-Dist: black>=22.3.0; extra == "dev"
Requires-Dist: isort>=5.0.0; extra == "dev"
Requires-Dist: mypy>=0.910; extra == "dev"
Requires-Dist: pylint>=2.5.0; extra == "dev"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: myst-parser; extra == "doc"
Requires-Dist: autodoc-pydantic>=2.2.0; extra == "doc"
Requires-Dist: ghp-import>=2.1.0; extra == "doc"
Requires-Dist: myst-parser>=4.0.0; extra == "doc"
Requires-Dist: sphinx-book-theme>=1.1.3; extra == "doc"
Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
Requires-Dist: sphinx-tabs>=3.4.7; extra == "doc"
Requires-Dist: sphinxcontrib-mermaid>=1.0.0; extra == "doc"
Requires-Dist: sphinx-gallery; extra == "doc"
Requires-Dist: sphinx-click; extra == "doc"
Provides-Extra: interactive
Requires-Dist: plotly>=5.0.0; extra == "interactive"
Provides-Extra: server
Requires-Dist: fastapi>=0.100; extra == "server"
Requires-Dist: uvicorn>=0.20; extra == "server"
Requires-Dist: python-multipart>=0.0.6; extra == "server"
Provides-Extra: client
Requires-Dist: httpx>=0.24; extra == "client"
Provides-Extra: reports
Requires-Dist: python-pptx>=1.0.2; extra == "reports"
Provides-Extra: plexos-duckdb
Requires-Dist: plexos2duckdb<0.2.0,>=0.1.0b11; extra == "plexos-duckdb"
Dynamic: license-file

# 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](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-7.4).

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.

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](https://natlabrockies.github.io/GridAnalysisToolkit/).
The example
[gallery](https://natlabrockies.github.io/GridAnalysisToolkit/gat_plot_examples/index.html)
is a good starting point for visual capability.

Highest-traffic doc pages (also readable directly in the repo):

- [Quickstart: scenarios and palettes](docs/source/scenario_quickstart.md)
- [Python API: `gat.load(...)`](docs/source/python_api_load.md)
- [Sienna scaling and raw dataset access](docs/source/sienna_scaling.md)
- [Custom plots and the reporting framework](docs/source/extending_plots.md)
- [v1 architecture & migration pattern](docs/source/architecture/v1_migration_pattern.md)
- [Legacy scenario handler deprecation](docs/source/legacy_handler_deprecation.md)
- [Migrating from v0.x to v1.0](docs/source/migration_v1.md)
- [Changelog](docs/source/CHANGELOG.md)

## 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, point
the `GAT_PLEXOS_FIXTURE` environment variable at a directory of
`.h5` solution files of your own. For the `plexos2duckdb`-backed
backend (`pip install nlr-gat[plexos-duckdb]`), point
`GAT_PLEXOS_ZIP_FIXTURE` at a native PLEXOS `Solution.zip` instead.

## 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]"`

## 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](DISCLAIMER.md) for the full disclaimer.
