Getting Started

Welcome to PyPSA-GB! This section will help you get up and running quickly.

• Installation
  • Step 1: Install Conda
  • Step 2: Clone the Repository
  • Step 3: Create the Conda Environment
  • Step 4: Install a Solver
  • Step 5: Verify Installation
  • Step 6: Download Weather Data
  • Directory Structure
  • Troubleshooting
  • Next Steps
• Quickstart: Run Your First Model
  • Prerequisites
  • Step 1: Check Available Scenarios
  • Step 2: Run a Scenario
  • Step 3: View Results
  • Step 4: Generate Analysis Outputs
  • Quick Commands Reference
  • Faster Testing with Reduced Networks
  • Expected Run Times
  • Next Steps
• Your First Custom Scenario
  • Understanding Scenarios
  • Step 1: View Existing Scenarios
  • Step 2: Create Your Scenario
  • Step 3: Activate Your Scenario
  • Step 4: Validate Configuration
  • Step 5: Run Your Scenario
  • Step 6: Analyze Results
  • Scenario Variations
  • Common Issues
  • Next Steps

Prerequisites

Before you begin, ensure you have:

• Python 3.10 or later

• Conda package manager (via Anaconda or Miniconda)

• Git for cloning the repository

• ~10GB disk space for data and results

• Gurobi solver (free academic license) or HiGHS (open-source)

Workflow

PyPSA-GB uses a Snakemake workflow to orchestrate the model:

1. Configure your scenario in YAML files

2. Run the Snakemake workflow

3. Analyse the results

For market studies, scenarios can also enable the optional two-stage market workflow: a copperplate wholesale solve followed by constrained balancing redispatch. See Market Dispatch once you are comfortable running a standard scenario.

If you encounter issues, check the Troubleshooting guide or open a GitHub Issue.