Technical References¶

Comprehensive technical documentation for EnergyAtlas platform components, APIs, and advanced features.

Overview¶

This section provides detailed technical references for developers, researchers, and advanced users working with EnergyAtlas. These documents cover API specifications, data formats, simulation parameters, and system architecture.

Available References¶

Core Documentation¶

• Data Preparation - Data formats, requirements, and preprocessing workflows
• Input Output Guide - File formats, data structures, and export options

Workflows¶

Detailed step-by-step workflows for common tasks:

• Workflows Guide - Overview of all available workflows
• Urban Data Integration - Importing and processing urban datasets
• Template Definition and Assignment - Creating and assigning building templates
• Running and Calibrating - Simulation execution and calibration procedures
• Scenario Design and Simulation - Creating and running retrofit scenarios
• Results View - Analyzing and visualizing simulation outputs

Energy Atlas Objects¶

Reference documentation for all object types in the EnergyAtlas data model:

• Datahub - Central data repository object
• Archetype - Building archetype definitions
• Archetype Assignment Rule - Rules for assigning archetypes to buildings
• Geospatial Data - Geographic and spatial data entries
• Weather File - Weather data file specifications
• Retrofit Measure - Energy efficiency retrofit definitions
• Scenario - Simulation scenario configurations

Using This Documentation¶

These technical references assume familiarity with: - Urban building energy modeling concepts - Basic GIS and spatial data formats - Energy simulation principles - JSON/CSV data formats

For introductory material, see the Quick Start section.