Introduction

JouleDB — JouleDB — energy-metered database, HDC primitives, joules per query.

This is the official documentation for JouleDB. The full source code lives in the private -core mirror; the public release surface is at openIE-dev/jouledb.

What you'll find here

  • Install — get the jouledb binary on your machine
  • Hello, JouleDB — first program in 30 seconds
  • Tutorial — a 30-minute hands-on guided tour
  • Reference — every feature, every flag, every API
  • Cookbook — task-oriented recipes
  • Design — why JouleDB exists and how it fits with the rest of openIE-dev

The openIE-dev ecosystem

JouleDB is one of five public openIE-dev projects. All five share a common substrate (flowG) and energy-metering layer (substrate-energy):

  • flow-g — the IR + runtime substrate
  • lux-lang — reactive language compiling to flowG
  • jmax — math-native language
  • joule-lang — energy-budgeted compiled language
  • jouledb — energy-metered database

License

JouleDB binaries are distributed under BSL-1.1. Documentation under CC-BY-4.0. Examples under Apache-2.0.