nova_ec
  • Home
  • API Reference
  • Tutorial
  • Getting Started
  • Configuration
  1. API Reference
  2. Function reference
  • Overview
    • Overview
  • Getting Started
    • Installation and Setup
    • Configuration
  • Tutorial
    • Project Setup Tutorial
  • API Reference
    • Function reference
    • Config Module
      • config_manager
    • Data Module
      • system_data
      • energy_community
    • Geocoding Module
      • geocoder
    • Matching Module
      • ec_matcher
      • county_matcher
      • eligibility
      • export_utils
    • Retrieval Module
      • data_retriever
    • Utils Module
      • logger
      • analysis_utils
    • Main Module
      • main
      • cli

On this page

  • Function reference
    • Config Module
    • Data Module
    • Geocoding Module
    • Matching Module
    • Retrieval Module
    • Utils Module
    • Main Module

Other Formats

  • Github (GFM)
  1. API Reference
  2. Function reference

Function reference

Config Module

Configuration handling for the package

config_manager Configuration management for Nova EC.

Data Module

Data loading and processing

system_data Module for loading and processing solar system data.
energy_community Module for loading and processing energy community data.

Geocoding Module

Geocoding functionality for solar system addresses

geocoder Module for geocoding solar system addresses.

Matching Module

Energy community matching algorithms

ec_matcher Module for matching solar systems to energy communities.
county_matcher Module for improved energy community matching using both county and spatial approaches.
eligibility Module for determining energy community eligibility based on system characteristics.
export_utils Utilities for cleaning and exporting energy community matching results.

Retrieval Module

Data retrieval functionality

data_retriever Example script for processing EC data using nova_fde.

Utils Module

Utility functions and helpers

logger Logging utilities for Nova EC.
analysis_utils Utility functions for energy community analysis workflow.

Main Module

Main execution pipeline

main Solar Systems Energy Community Analysis Pipeline
cli Command-line interface for Nova EC.
Project Setup Tutorial
config_manager
 
 
  • Built with [Quarto](https://quarto.org/) and [quartodoc](https://machow.github.io/quartodoc/)