Welcome to OEDS’s Documentation!

Welcome to the official documentation for OEDS! This guide will help you get started, walk you through examples, and provide detailed instructions on backup, restore, and migration processes.

Contents:

• Open Energy Data Server
  • TimeScaleDB
  • PostGIS
  • Contributing
  • Citation
  • Using the ECMWF crawler
• Getting Started
  • Requirements
  • Setting up the server
  • Crawlers
  • CLI tool
  • Usage
  • More resources

OEDS Architecture

OEDS Workflow

Mini Walkthrough

• Minimal Example Walkthrough - Step-by-step walkthrough of a minimal example using Open Power System Data (OPSD) national energy generation dataset.

  • opsd_national_generation_capacity_crawler.py - Python crawler for national generation capacity.

  • postgrest_stored_procedure.sql - Stored procedure for PostgREST.

  • python_postgrest_visualise.py - Python script for PostgREST visualization.

Usage Examples

• Application Examples - Application examples.

• Client Export Examples - Export examples for SQL clients.

• HTTP Export Examples - Examples for exporting via HTTP.

• SQL Helpers - SQL helpers for metadata operations.

Backup and Migration

• Backup, Restore, and Migration - Comprehensive guide for backup, restore, and migration.

  • dummy_db.sh - Script for dummy database setup.

  • db_migrate.sh - Script for whole database migration.

  • schema_migrate.sh - Script for individual schema migration.