RES APIs

RES APIs#

Warning

This page is under heavy development

RESource Builder#

Main class for the RESource framework providing renewable energy resource assessment capabilities.

Annual Technology Baseline (ATB)#

Processor for NREL's Annual Technology Baseline data.

ℹ️ The ATB data source and configuration may change annually. Ensure you are referencing the correct year and dataset for your analysis.

  • Currently configured for 2024 ATB.

  • Please review and update configuration if using for a different year or context.

Administrative Boundaries#

Handler for GADM administrative boundary data.

Note

If the above documentation doesn't render properly, this indicates import issues with heavy geospatial dependencies. The GADMBoundaries class provides:

  • download_boundaries(country_code): Downloads boundary data for the specified country

  • get_regions(): Retrieves available administrative regions

  • process_boundaries(): Processes and validates boundary data

ℹ️ RES.boundaries.GADMBoundaries is to be used for standalone data download/validation purposes.

Spatial Grid Cell Processor#

Note

If the above documentation doesn't render, these classes provide grid cell processing capabilities for spatial analysis.

Global Land Cover#

Global Wind Atlas#

Handler for Global Wind Atlas data processing.

Visualization#

Scorer#

Note

If the above documentation doesn't render, this class provides cell scoring capabilities for renewable energy site assessment.

Clustering#

Note

If the above documentation doesn't render properly, this module provides clustering algorithms for renewable energy resource grouping and analysis.

Local Data Store with HDF5 file#

Note

If the above documentation doesn't render, this class provides HDF5-based data storage and retrieval capabilities for the RESource framework.

Turbine Configuration#

class RES.tech.OEDBTurbines(OEDB_config: dict)[source]#

Bases: object

fetch_turbine_config(model)[source]#

Fetches turbine data based on the resource type (e.g., 'wind') and saves the formatted configuration for the turbines found.

format_and_save_turbine_config(turbine_data: dict, save_to: str)[source]#

Formats (to sync Atlite's Requirement) and saves the turbine's specification data to a YAML configuration file.

Parameters:

  • turbine_data (-) -- Turbine specification data.

  • save_to (-) -- The directory path where the YAML file will be saved.

load_turbine_config()[source]#

Units#

Warning

This page is under heavy development

Contents