dsgrid Documentation¶
Active Development
The dsgrid toolkit is under active development and details are subject to change. Please reach out to the dsgrid team with questions or feedback.
What is dsgrid?¶
The demand-side grid (dsgrid) toolkit is a Python framework for compiling high-resolution energy demand datasets across multiple dimensions: time, geography, sector, subsector, end use, etc. dsgrid enables researchers, analysts, and planners to integrate diverse energy datasets into cohesive projects suitable for power system analysis, policy evaluation, and energy planning.
For more information, please visit https://www.nrel.gov/analysis/dsgrid.html.
Getting Started by Role¶
Quick Links for Stakeholders¶
If you’re evaluating dsgrid for your organization:
Capabilities Overview: See dsgrid Fundamentals for a high-level introduction
Published Work: Browse Published Datasets and Publications to see dsgrid in action
Technical Team: Direct your technical staff to Getting Started
dsgrid Webpage: Visit https://www.nrel.gov/analysis/dsgrid.html
Key Features¶
Multi-Dimensional Data: Organize energy data across scenario, geography, time, sector, subsector, enduse, and custom dimensions
Flexible Mappings: Map datasets between different dimensional systems with explicit, documented transformations
Powerful Queries: Aggregate, filter, and transform data across dimensions to create custom views
Big Data Support: Process terabyte-scale datasets using Apache Spark or gigabyte-scale datasets using DuckDB
Data Integrity: Validation ensures dataset consistency and project compatibility
Registry System: Central metadata management for dimensions, datasets, and projects
Documentation Sections¶
User Guide¶
dsgrid Fundamentals - Core concepts and architecture
Tutorials - Step-by-step learning guides
How-To Guides - Quick reference for specific tasks
Topic Deep Dives¶
Dataset Registration - Requirements, formats, and validation
Dataset Mapping - Dimension mappings and workflows
Dataset Submittal - Submission process and checks
Project Creation - Building dsgrid projects
Project Queries - Querying and analyzing projects
Project Derived Datasets - Creating derived datasets
Advanced Topics¶
Apache Spark - Working with large-scale datasets
Software Reference¶
CLI Reference - Command-line interface documentation
Software Architecture - System design and components
Data Models - Configuration and data model specifications
Additional Resources¶
Publications - Research papers and reports using dsgrid
Citation & Attribution - How to cite dsgrid and datasets
Contact - Get help or provide feedback