Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

104 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenTech-DB

An Open Energy Ontology (OEO)-aligned database, REST API, and React 19 web frontend for energy generation, storage, transmission, and conversion technologies — designed to feed real, traceable data into energy modelling frameworks (Calliope, PyPSA, OSeMOSYS, ADOPTNet0).

Python FastAPI React Vite License: MIT Data: CC BY 4.0 OEO

Full documentation


Quick Start

Backend

git clone https://github.com/THD-Spatial-AI/OpenTech-DB.git
cd opentech-db
make install     # dependencies + Supabase data services + Keycloak/auth stack
make backend
Interface URL
Swagger UI http://127.0.0.1:8000/docs
ReDoc http://127.0.0.1:8000/redoc
Web UI http://localhost:5173
Keycloak Admin Console http://localhost:8080/admin/

Frontend (separate terminal)

make frontend

Restarting the authentication stack

make auth

Authentication uses the standalone Go service and the isolated opentechdb Keycloak realm. React never receives Keycloak tokens and does not use keycloak-js. Signed-in users can create revocable, hashed personal API tokens from their profile for scripts and integrations; see Authentication.


Documentation

Topic Link
Overview & technology coverage docs/overview.md
Installation & configuration docs/getting-started.md
API reference docs/api-reference.md
Integration guide (Python, PyPSA, Calliope) docs/integration.md
Data model docs/data-model.md
JSON data formats & adding technologies docs/data-formats.md
Framework adapters docs/adapters.md
Time-series catalogue docs/timeseries.md
Authentication docs/authentication.md
Web frontend docs/frontend.md
Contributing data (researchers) docs/contributing-data.md

License

Code is released under the MIT License.
Catalogue data (data/) and documentation are released under CC BY 4.0 — you are free to use, share, and adapt with attribution.

About

An Open Energy Ontology (OEO)-aligned database, REST API, and React 19 web frontend for energy generation, storage, transmission, and conversion technologies — designed to feed real, traceable data into energy modelling frameworks (Calliope, PyPSA, OSeMOSYS, ADOPTNet0)

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages