From 5104979cb02389d715cc43803ab174488241414d Mon Sep 17 00:00:00 2001 From: micahpw <6476273+micahpw@users.noreply.github.com> Date: Tue, 4 Aug 2026 12:53:43 -0600 Subject: [PATCH 1/2] docs: mark ReEDS with (TM) on first reference in public-facing docs Applies to README/docs-site prose, AGENTS.md, and llms.txt -- one mark per document on its first mention, not internal source comments, docstrings, or CLI help strings. --- AGENTS.md | 2 +- docs/source/CHANGELOG.md | 2 +- docs/source/_llms_root/llms.txt | 2 +- docs/source/api/ScenarioObjects/ReEDS.md | 2 +- docs/source/architecture/base_system.md | 2 +- docs/source/cli_commands.md | 2 +- docs/source/cli_project_management.md | 2 +- docs/source/cli_quick_reference.md | 2 +- docs/source/index.md | 2 +- docs/source/migration_v1.md | 2 +- docs/source/palette_generation.md | 2 +- docs/source/plugin_development_guide.md | 2 +- docs/source/python_api_load.md | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 257aa16..10bc152 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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. diff --git a/docs/source/CHANGELOG.md b/docs/source/CHANGELOG.md index e2578c5..3adabc2 100644 --- a/docs/source/CHANGELOG.md +++ b/docs/source/CHANGELOG.md @@ -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 diff --git a/docs/source/_llms_root/llms.txt b/docs/source/_llms_root/llms.txt index f4702ab..1d398a0 100644 --- a/docs/source/_llms_root/llms.txt +++ b/docs/source/_llms_root/llms.txt @@ -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. diff --git a/docs/source/api/ScenarioObjects/ReEDS.md b/docs/source/api/ScenarioObjects/ReEDS.md index 125190b..0dfaeaf 100644 --- a/docs/source/api/ScenarioObjects/ReEDS.md +++ b/docs/source/api/ScenarioObjects/ReEDS.md @@ -1,5 +1,5 @@ -## ReEDS +## ReEDS™ ```{eval-rst} .. automodule:: gat.scenariohandlers.reeds :members: diff --git a/docs/source/architecture/base_system.md b/docs/source/architecture/base_system.md index 0c563c2..a9b7e27 100644 --- a/docs/source/architecture/base_system.md +++ b/docs/source/architecture/base_system.md @@ -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 diff --git a/docs/source/cli_commands.md b/docs/source/cli_commands.md index 02d4da0..74b4a54 100644 --- a/docs/source/cli_commands.md +++ b/docs/source/cli_commands.md @@ -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 diff --git a/docs/source/cli_project_management.md b/docs/source/cli_project_management.md index b644205..26377d0 100644 --- a/docs/source/cli_project_management.md +++ b/docs/source/cli_project_management.md @@ -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 diff --git a/docs/source/cli_quick_reference.md b/docs/source/cli_quick_reference.md index f6ee805..96f8940 100644 --- a/docs/source/cli_quick_reference.md +++ b/docs/source/cli_quick_reference.md @@ -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 \ diff --git a/docs/source/index.md b/docs/source/index.md index a0bcd47..98241b3 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -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 diff --git a/docs/source/migration_v1.md b/docs/source/migration_v1.md index 3a7da46..dd59370 100644 --- a/docs/source/migration_v1.md +++ b/docs/source/migration_v1.md @@ -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 diff --git a/docs/source/palette_generation.md b/docs/source/palette_generation.md index 14bd3f2..2dd3287 100644 --- a/docs/source/palette_generation.md +++ b/docs/source/palette_generation.md @@ -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. diff --git a/docs/source/plugin_development_guide.md b/docs/source/plugin_development_guide.md index d483802..6561c36 100644 --- a/docs/source/plugin_development_guide.md +++ b/docs/source/plugin_development_guide.md @@ -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 diff --git a/docs/source/python_api_load.md b/docs/source/python_api_load.md index a5aadbf..a5bb46a 100644 --- a/docs/source/python_api_load.md +++ b/docs/source/python_api_load.md @@ -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:** From e2f8426edba58e297bc0d3897c9a9261481a0d61 Mon Sep 17 00:00:00 2001 From: micahpw <6476273+micahpw@users.noreply.github.com> Date: Tue, 4 Aug 2026 13:00:18 -0600 Subject: [PATCH 2/2] docs: mark ReEDS with (TM) in PyPI keywords too, for consistency --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 4641148..c380dde 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,7 +39,7 @@ keywords = [ "PLEXOS", "Sienna", "PowerSimulations.jl", - "ReEDS", + "ReEDS™", "energy modeling", ] classifiers = [