Cardamon
🌱 The Car(bon) da(shboard) and live mon(itor)
Built with ❤️ by the Root & Branch team
Uh, it's cardmom ACKSUALLY! - we know, but cardamon is a better acronym.
---
Cardamon is a tool to help development teams measure the power consumption and carbon emissions of their software.
- [Introduction](#introduction)
- [Installation](#installation)
- [Quickstart](#quickstart)
- [Environment Variables](#environment-variables)
- [Configuration](#configuration)
- [CLI](#cli)
- [FAQ](#faq)
- [License](#license)
# Introduction
Cardamon is built around the concept of observations and scenarios.
A scenario encapsulates a usage behaviour that you want to measure (e.g. add items to basket). You can then run your code against these repeateable behaviours and see how your software power consumption changes over time. You can view this in the cardamon-ui. Cardamon scenarios are compatible with [ISO/IEC 21031 - Software Carbon Intensity (SCI) specification](https://www.iso.org/standard/86612.html).
An observation is a measurement of one or more scenarios.
# Installation
The easiest way to install Cardamon is using our install script.
**Linux & Mac**
`curl -fsSL https://cardamon.io/install.sh | sh`
**Windows**
```
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
irm -Uri https://cardamon.io/install.ps1 | iex
```
**Cargo**
Alternatively you can build Cardamon from source if you have `cargo` installed.
`cargo install cardamon`
# Quickstart
`cardamon init` - create a new cardamon configuration file.
`cardamon run