Skip to content

Commit

Permalink
Document how to run benchmarks
Browse files Browse the repository at this point in the history
From downloading the tar archive, extracting, and running the benchmark via `cargo bench`.
  • Loading branch information
weiji14 committed Oct 8, 2024
1 parent 5ec45e0 commit b4f22b8
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions benches/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Benchmarks

Measure the throughput of reading/writing GeoTIFF files using this library!

Steps to run:

1. Download the tar archive of GeoTIFF files, placing them in the `resources/` folder

```bash
wget https://s3.us-east-2.amazonaws.com/geotiff-benchmark-sample-files/geotiff_sample_files.tar.gz -P resources
```

2. Extract the tar archive

```bash
tar --extract --verbose --file resources/geotiff_sample_files.tar.gz
```

3. Run the benchmarks

```bash
cargo bench
```

## Results

TODO

## References
- https://github.com/kokoalberti/geotiff-benchmark

0 comments on commit b4f22b8

Please sign in to comment.