Skip to content

Commit

Permalink
Add README for locustdb-compression-utils
Browse files Browse the repository at this point in the history
  • Loading branch information
cswinter committed Mar 30, 2024
1 parent b6aef44 commit 579b163
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions locustdb-compression-utils/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# LocustDB Compression Utils

Collection of utils for compressing a series of values.

## XOR float compression

One of compression algorithms implemented is a variant of the XOR float compression algorithm described in [Gorilla: A Fast, Scalable, In-Memory Time Series Database](https://www.vldb.org/pvldb/vol8/p1816-teller.pdf). The "gorilla_time" example program creates visualizations of the compression algorithm. You can run the visualization with:

```bash
cargo run --example gorilla_time -- --verbose
```

Run the following command to see more options:

```bash
cargo run --example gorilla_time -- --help
```

0 comments on commit 579b163

Please sign in to comment.