# Bit Goblin Benchmarking States

A collection of SaltStack states to configure benchmarking systems consistently.

## Deploying

The only thing required for deploying and running these states is [Salt Formula Manager](https://git.metaunix.net/Metaunix/salt-formula-manager).

To install the formulas with SFM: `sfm`

## Running States

The states in this collection are intended to be run via Salt SSH, or a Salt run locally. You *can* run them via a Salt minion/master setup, **but you should verify the minion is disabled before benchmarks are run** to make sure it doesn't impact benchmarks.

Apply states: `salt-call -c ./config --local state.apply`

## Available States

* `gaming` - installs software needed for running gaming benchmarks (e.g. Steam, MangoHUD)
* `cpu_compute` - installs benchmarks/tools needed for running CPU compute benchmarks
* `gpu_compute` - installs benchmarks/tools needed for running GPU compute benchmarks

## Development

To run the Salt Linter, use the script in `./bin/salt-lint.sh`:

`./bin/salt-lint.sh`

This requires installing Docker.