Retire: Coal Plant Retirement Analysis

Welcome to the documentation for the retire package, a comprehensive tool for analyzing coal plant retirement strategies based on research published in Nature Energy.

Overview

The retire package provides data and analysis tools for US coal plant retirement analysis based on research published in Nature Energy.

Key Features:

• Comprehensive Dataset: Detailed coal plant data with operational and contextual factors

• Network Analysis: Analyze plant relationships using similarity metrics

• Visualization Suite: Rich plotting capabilities for retirement patterns

• Research Reproducibility: Access to manuscript results and analysis

Quick Start

from retire import Retire, Explore

# Load data and create analysis objects
retire_obj = Retire()
explore = Explore(retire_obj.graph, retire_obj.raw_df)

# Visualize the network
fig, ax = explore.drawGraph(col='ret_STATUS')

# Create geographic map
fig, ax = explore.drawMap()

# Get manuscript results
group_analysis = retire_obj.get_group_report()
explanations = retire_obj.get_target_explanations()

Getting Started:

• Usage Guide
  • Installation
  • Quick Start
  • Loading Data
  • Initializing the Explorer
  • Basic Graph Visualization
  • Component-Level Analysis
  • Advanced Visualizations
  • Accessing Results and Analysis
• Data Sources
• Visualization Methods
  • Graph Visualizations
  • Statistical Visualizations
  • Flow and Distribution Charts
  • Geospatial Visualizations
• Configuration Guide
  • Basic Usage
  • Configuration Structure

API Reference:

• Retire Module
  • Retire
  • Main Classes
  • Analysis Methods
• Data Module
  • load_dataset()
  • load_clean_dataset()
  • load_projection()
  • load_graph()
  • load_generator_level_dataset()
  • Data Loading Functions
  • Data Utilities
• Explore Module
  • Explore
  • Main Classes
  • Utility Functions
  • Visualization Methods
  • Analysis Methods

Development:

• Development & Testing