Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ If you're looking for how to *use* GAT as a library, see the
## What this is

GAT (`nlr-gat` on PyPI) is a format-agnostic API over grid-model
simulation outputs (Sienna, PLEXOS, ReEDS), with a thin core and
simulation outputs (Sienna, PLEXOS, ReEDS), with a thin core and
per-format extras so consumers only install the native-code dependencies
(h5py, duckdb, geopandas, polars, matplotlib) their format actually needs.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ See [v1 migration pattern](architecture/v1_migration_pattern.md).
- `gat project scenario list` lists all scenarios across all projects or
filters by a specific project ID
- User metadata system for lightweight project references
- Support for Sienna, ReEDS, and Plexos scenarios
- Support for Sienna, ReEDS, and Plexos scenarios

#### Simulation and system abstraction

Expand Down
2 changes: 1 addition & 1 deletion docs/source/_llms_root/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> A format-agnostic Python API for reading Production Cost Model (PCM)
> and Capacity Expansion Model (CEM) simulation outputs — Sienna
> (PowerSimulations.jl), PLEXOS, and ReEDS today — into pandas
> (PowerSimulations.jl), PLEXOS, and ReEDS today — into pandas
> DataFrames, without needing to know each format's native file layout.
> Distributed on PyPI as `nlr-gat` (import as `gat`); source at
> https://github.com/NatLabRockies/GridAnalysisToolkit.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/ScenarioObjects/ReEDS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

## ReEDS
## ReEDS
```{eval-rst}
.. automodule:: gat.scenariohandlers.reeds
:members:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/architecture/base_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

The `BaseSystem` abstraction provides a unified interface for reading system files from different simulation platforms (Sienna, ReEDS, Plexos, etc.). This abstraction enables:
The `BaseSystem` abstraction provides a unified interface for reading system files from different simulation platforms (Sienna, ReEDS, Plexos, etc.). This abstraction enables:

- **Palette auto-generation**: Automatically create palette configurations from system metadata
- **Platform independence**: Write code that works across different simulation platforms
Expand Down
2 changes: 1 addition & 1 deletion docs/source/cli_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ gat project scenario add TYPE SCENARIO_ID [OPTIONS]
- `--simulation TEXT` - Path to simulation HDF5 (required, repeatable)
- `--metadata TEXT` - Path to GAT metadata JSON

**ReEDS Options:**
**ReEDS Options:**
- `--path TEXT` - Path to ReEDS output directory (required)
- `--solve-year INTEGER` - Solve year to analyze

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cli_project_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ Adds a scenario configuration to a project.
- `--simulation TEXT` - Path to simulation HDF5 file (required, can specify multiple)
- `--metadata TEXT` - Path to GAT metadata JSON file

**ReEDS Options:**
**ReEDS Options:**
- `--path TEXT` - Path to ReEDS output directory (required)
- `--solve-year INTEGER` - Solve year to analyze

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cli_quick_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ gat project add-scenario sienna multi_week \
--simulation ../data/week3.h5
```

### Add ReEDS Scenario
### Add ReEDS Scenario

```bash
gat project add-scenario reeds SCENARIO_ID \
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ GAT v1.0 introduces a comprehensive project management system for organizing you

**Key Features:**
- Initialize projects with standard directory structure
- Add scenarios (Sienna, ReEDS, Plexos) via CLI
- Add scenarios (Sienna, ReEDS, Plexos) via CLI
- Share projects via git repositories
- User-level project references for easy access
- Support for palettes, pipelines, and notebooks
Expand Down
2 changes: 1 addition & 1 deletion docs/source/migration_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ First, see what data sources you have configured:
gat sources list
```

This shows your existing Sienna, ReEDS, or Plexos data sources.
This shows your existing Sienna, ReEDS, or Plexos data sources.

### Step 2: Create Projects from Data Sources

Expand Down
2 changes: 1 addition & 1 deletion docs/source/palette_generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Extracts information from Sienna JSON system files:
gat project add-palette my_palette sienna_scenario
```

### ReEDS (Future)
### ReEDS (Future)

Support for ReEDS system files is planned for a future release.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/plugin_development_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This guide explains how to extend GAT to support new simulation tools and system
GAT uses a plugin architecture that allows developers to add support for new simulation tools and system formats without modifying the core codebase. The architecture consists of:

1. **Base Interfaces**: Abstract classes that define the required API
2. **Concrete Implementations**: Plugin implementations for specific tools (Sienna, ReEDS, PLEXOS, etc.)
2. **Concrete Implementations**: Plugin implementations for specific tools (Sienna, ReEDS, PLEXOS, etc.)
3. **Automatic Aggregation**: GAT handles combining multiple files transparently

### Key Design Principles
Expand Down
2 changes: 1 addition & 1 deletion docs/source/python_api_load.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ The `load()` function returns a tuple of three objects:
### 1. Scenario Object
A scenario handler instance for interacting with simulation data:
- `SiennaScenario` for Sienna simulations
- `ReEDsScenario` for ReEDS simulations
- `ReEDsScenario` for ReEDS simulations
- `PlexosScenario` for Plexos simulations

**Usage:**
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ keywords = [
"PLEXOS",
"Sienna",
"PowerSimulations.jl",
"ReEDS",
"ReEDS",
"energy modeling",
]
classifiers = [
Expand Down
Loading