# Energy Benchmarking Tool
Tool for benchmarking the energy consumption of programs.
Idle energy consumption is automatically excluded.
The energy benchmarking Rust crate can be added to your pre-existing Rust project with `cargo add energy-bench`.
The tool is continuously being updated, so please make sure you are using the most recent version with `cargo update -p energy-bench`.
Please read the online [wiki](https://gitlab.com/software-energy-lab/energy-benchmarking/-/wikis/home) for installation setup and usage instructions.
Check out the `example` folder for a few examples, and check the `.gitlab-ci.yml` for an example of how to run the _Software Energy Lab_ pipeline.
### TODO
- It might be nice if we provide a function for `repeating`
- Allow user to specify output path.
- Minimum runtime warning only once per benchmark.