co2-calculator developer docs¶
co2-calculator is an open-source web app from EPFL. Labs use it to measure, show and simulate their CO2 emissions. This site keeps the maintenance cheap, helps new contributors start fast, and gives LLM agents stable anchors in the code.
The docs cover the product scope (the CRD, or spec), the system architecture and the decision records. Each part has a guide: backend, frontend, database and infrastructure.
Something is broken?¶
- Operations: where to look, who to call, what to expect
- Tools and access: each dashboard and how to get access
Install it¶
- Install the CO2 Calculator: Docker Compose or Skaffold on one machine, the Helm chart or Kustomize on Kubernetes
Start here: humans¶
Start here: LLM agents¶
How decisions are made¶
The architectural decisions are in architecture-decision-records/.
Each ADR (architecture decision record) gives the context, the options
and the consequences. The CRD in architecture/spec.md is the product
requirement that has authority. The delivery detail of each GitHub
issue is in docs/src/implementation-plans/, one file for each issue.
The Implementation Plans section of
the menu lists them.