OPEN-PROM Logo

Getting started

  • Overview
  • Setup and environment
    • Key terminology
    • Git and GitHub setup
      • Check for an existing Git installation
      • Install Git
      • Create and configure a GitHub account
      • Clone the repository
      • Commit and push changes
    • Visual Studio Code
      • Install VS Code
      • Orientation
      • Recommended extensions
    • Task runner
      • Setup
      • Run modes
    • Troubleshooting
      • Git installation fails
      • GitHub authentication fails
      • Cloning fails
      • VS Code / Git integration problems
    • Modelling server (Windows)
      • Connecting
      • System preparation
      • Install core software (system-wide)
      • Install MAgPIE system-wide (no renv)
      • Python, TinyTeX and shared storage
      • Linux support — WSL (per-user)
      • Test the setup
  • Running the model
    • A first run (public dummy data)
    • Running with real input data
      • Point R to the local madrat archive
      • How data/ and targets/ are created
      • Task modes in start.R
      • Batch mode
      • What the outputs mean
    • Changing the region set

How-to guides

  • Input data
    • Installing the software and libraries
    • Creating the local configuration file
    • Adding the data sources
    • Updating the CI dataset
    • Running the model
  • Development and code structure
    • Folder structure
    • The phase system
    • Modules and realizations
    • Default active vs dormant features
    • Naming convention
    • Developer workflow
  • Soft-linking
    • Soft-linking with MAgPIE
      • Prerequisites
      • Running an iteration
      • Configuration
      • Convergence controls and state files
      • Emulator alternative (without running MAgPIE)
    • Soft-linking with climate emulators (METEOR)
      • Workflow
      • One-way vs iterative use

Model documentation

  • 1. Introduction
  • 2. Model overview
    • 2.1. Time granularity and regions
    • 2.2. Sector granularity
    • 2.3. Gap and substitution mechanism
      • 2.3.1. Gap and scrapping mechanism
      • 2.3.2. Substitution mechanism
      • 2.3.3. Implementation by realisation
    • 2.4. Prices
      • 2.4.1. Conceptual framing (legacy)
      • 2.4.2. Active price formation (current code)
    • 2.5. Energy supply
      • 2.5.1. Trade representation
      • 2.5.2. End-use sector: biofuel blending
  • 3. Demand sectors
    • 3.1. Industry and domestic demand
    • 3.2. Residential and commercial
    • 3.3. Transport and bunkers demand
    • 3.4. Carbon Dioxide Removal (CDR) technologies
  • 4. Supply sectors
    • 4.1. Power supply
    • 4.2. Heat supply
    • 4.3. Hydrogen supply
      • 4.3.1. Supply–demand alignment and sector coupling
      • 4.3.2. Output and role in the full energy system
    • 4.4. Supply of other fuels
  • 5. Data pipeline and calibration
    • 5.1. Input data sources and data preparation
    • 5.2. Output post-processing
    • 5.3. Calibration mechanism
  • 6. Model interlinkages
    • 6.1. Link with openTEPES
    • 6.2. Link with METEOR
      • 6.2.1. Overview of METEOR
      • 6.2.2. Rationale for linking METEOR with OPEN-PROM
      • 6.2.3. Coupling workflow between OPEN-PROM and METEOR
      • 6.2.4. Added value for OPEN-PROM
    • 6.3. Circular economy representation with OMNIA-ENGAGE
    • 6.4. Link with FTT:Heat
    • 6.5. Link with MAgPIE
  • 7. Baseline results
    • 7.1. Baseline emissions
    • 7.2. Final energy demand
    • 7.3. Fuel shares and electrification
    • 7.4. Electricity generation and power-sector transformation

Reference

  • GAMS error codes
    • Compile-time errors
    • Execution-time solver and model-status issues
    • License errors
    • General troubleshooting tips
  • Abbreviations
  • Bibliography and data sources
    • References
    • Data sources and tools

Project

  • About
    • Acknowledgements and funding
    • How to cite
    • Links
OPEN-PROM
  • Search

© Copyright 2026, E3Modelling.

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