OSeMOSYS-RDM

Getting Started

  • Installation
    • Prerequisites
      • Required Software
      • Optional Software
    • Installation Methods
      • Option 1: Automated Setup (Recommended)
      • Option 2: Manual Setup
    • Solver Installation
      • GLPK (Required)
      • CBC (Free, Optional)
      • Commercial Solvers
    • Verifying Installation
    • Troubleshooting
      • Common Issues
    • Next Steps
  • Quickstart Guide
    • Overview
    • Step 1: Prepare Input Scenarios
    • Step 2: Configure the Run
      • Key Configuration Sheets
      • Essential Setup Parameters
    • Step 3: Run the Pipeline
      • Execute Complete Workflow
      • Example: First Run
    • Step 4: Review Results
      • Output Files
    • What’s Next?
  • Configuration
    • Main Configuration File
    • Setup Sheet
      • Solver Selection
    • To_Print Sheet
    • Uncertainty_Table Sheet
      • Column Definitions
      • Mathematical Types
      • Example Uncertainty Definition
    • Params_Sets_Vari Sheet
    • DVC Configuration
      • dvc.yaml
    • PRIM Configuration
      • PRIM_t3f2.yaml
      • prim_structure.xlsx
      • prim_files_creator_cntrl.xlsx
    • Environment Configuration
      • environment.yaml
    • File Structure Configuration

User Guide

  • Workflow Overview
    • What is OSeMOSYS-RDM?
    • Architecture Overview
    • Pipeline Stages
      • Stage 1: Base Future (Future 0)
      • Stage 2: RDM Experiment
      • Stage 3: Postprocessing
      • Stage 4: PRIM Files Creator
      • Stage 5: PRIM Analysis
    • Execution Modes
      • Full Automated Execution
      • Selective Execution
      • Manual Stage Execution
    • Data Flow
      • Input Data
      • Intermediate Data
      • Output Data
    • OSeMOSYS Compatibility
      • Tested Formulations
      • Compatible Model Features
  • RDM Pipeline
    • What is RDM?
    • Pipeline Stages
      • 1. Base Future Generation
      • 2. Uncertainty Sampling
      • 3. Future Generation and Solving
        • Automatic Data Preprocessing
        • EV UDC Sign Correction
      • 4. Result Aggregation
    • Configuring Uncertainties
      • Uncertainty Table Structure
      • Mathematical Types
        • Time_Series
        • Constant
        • Linear
        • Logistic
        • Timeslices_Curve
      • Example: Fuel Cost Uncertainty
      • Example: Technology Capacity Uncertainty
    • Running the RDM Pipeline
      • Quick Start
      • Monitoring Progress
    • Parallel Execution
      • Configuration
      • Calculating Parallel_Use Based on Your Machine
        • Single-thread solvers (CBC, GLPK)
        • Multi-thread solvers (CPLEX, Gurobi)
        • Summary Table
      • Memory Considerations
    • Output Structure
      • Per-Future Outputs
      • Aggregated Outputs
    • Solution Status Report
      • Report Format
      • What Happens Internally
    • Best Practices
      • 1. Start Small
      • 2. Validate Base Future
      • 3. Use Appropriate Ranges
      • 4. Group Related Uncertainties
      • 5. Document Your Choices
  • PRIM Analysis
    • What is PRIM?
    • Why Use PRIM?
    • Running PRIM Analysis
      • Configuration Guide
      • Quick Start
      • Prerequisites
      • What Happens
    • Configuration Files
      • 1. prim_structure.xlsx
      • 2. PRIM_t3f2.yaml
      • 3. prim_files_creator_cntrl.xlsx
      • 4. Units.xlsx
    • Defining Outcomes
      • Cost Outcomes
      • Emission Outcomes
      • Technology Outcomes
    • Defining Drivers
      • Input Parameter Driver
      • Derived Driver
    • Outcome Classification
      • Custom Thresholds
    • Understanding Results
      • Predominant Ranges
      • Reading PRIM Boxes
      • Trade-off Curve
    • Best Practices
      • 1. Start with Clear Questions
      • 2. Validate Results
      • 3. Iterate on Analysis
      • 4. Document Findings
    • Example Workflow
      • 1. Define the Question
      • 2. Configure Outcome
      • 3. Run PRIM
      • 4. Analyze Results
      • 5. Policy Implications
    • Output Files
      • sd_ana_exp_Experiment.csv
      • t3f4_predominant_ranges_*.xlsx
      • *.pickle Files
  • Interface Configuration Guide
    • Overview
    • Sheet Reference
    • Setup Sheet
      • Parameter Reference
        • Execution Control
        • Solver Configuration
        • Model Settings
        • RDM Settings
        • EV UDC Sign Correction
      • Example Configuration
    • To_Print Sheet
      • Structure
      • Common Output Variables
        • Cost Variables
        • Capacity Variables
        • Activity Variables
        • Emission Variables
        • Trade Variables
    • Uncertainty_Table Sheet
      • Column Definitions
        • Identification
        • Mathematical Specification
        • OSeMOSYS Mapping
        • Temporal Settings
      • X_Mathematical_Type Options
        • Time_Series
        • Constant
        • Linear
        • Logistic
        • Step
        • Timeslices_Curve
      • Explored_Parameter_of_X Options
      • Example Entries
        • Fuel Cost Uncertainty
        • Technology Limit Uncertainty
        • Demand Shape Uncertainty
        • Zero-Baseline Parameter (Step Function)
        • Complementary Dependency Between Parameters
    • Params_Sets_Vari Sheet
      • Structure
      • Set Type Values
      • Example Entries
    • Validation Tips
      • Before Running
      • Common Errors
  • DVC Integration
    • Why DVC?
    • Main Pipelines
      • python run.py rdm
      • python run.py prim
      • python run.py all
    • Pipeline Structure
    • Visualizing the DAG
    • The dvc.lock File
    • Ignoring Files
    • Workflow with Git + DVC
      • Typical Development Cycle
      • Reproducing on Another Machine
    • Running Without Git
    • Metrics Tracking
    • Best Practices
      • 1. Commit dvc.lock
      • 2. Use Remotes for Large Files
      • 3. Document Parameter Changes
      • 4. Regular Pushes
      • 5. Clean Up Cache

Results & Examples

  • Example Execution
    • Step-by-Step Execution Guide
      • Step 1: Open Anaconda Prompt
      • Step 2: Navigate to Repository
      • Step 3: Run the Model
      • Step 4: Process Starts
      • Step 5: Process Completes
    • Understanding the Output
      • Changes to the Environment Name
OSeMOSYS-RDM
  • Search

© Copyright 2026, Climate Lead Group.

Built with Sphinx using a theme provided by Read the Docs.