Quick Start Guide¶

This guide will help you run your first PyPSA-Earth model in under 10 minutes.

Prerequisites¶

Before starting, ensure you have:

Completed the installation
At least 8GB of RAM available
A working internet connection (for data download)

Run the Tutorial Model¶

The quickest way to get started is to run the pre-configured tutorial model for Nigeria.

1. Activate the Environment¶

conda activate pypsa-earth

2. Run the Model¶

Execute the tutorial workflow:

snakemake -call results/NG/networks/elec_s_6_ec_lcopt_Co2L-4H.nc --configfile config.tutorial.yaml

This command will:

Download required data for Nigeria
Build the power system network
Run the optimization
Generate results

The tutorial model typically completes in 5-15 minutes depending on your system.

3. View Results¶

Once complete, you can find:

Network file: results/NG/networks/elec_s_6_ec_lcopt_Co2L-4H.nc
Summary statistics: results/NG/stats/
Plots: results/NG/plots/

What's Next?¶

Now that you've run your first model, explore:

Electricity Tutorial - Learn to customize electricity models
Sector-Coupled Tutorial - Build multi-sector models
Configuration Guide - Understand all configuration options
Model Customization - Adapt the model to your needs

Troubleshooting¶

Out of Memory¶

If you encounter memory issues, try reducing the model size:

# In config.tutorial.yaml
scenario:
  clusters: [3]  # Reduce from 6 to 3

Data Download Issues¶

If data download fails:

# Clear cache and retry
snakemake -call --delete-all-output
snakemake -call results/NG/networks/elec_s_6_ec_lcopt_Co2L-4H.nc --configfile config.tutorial.yaml

Solver Errors¶

Ensure you have a solver installed. See Installation - Solver Installation.