https://github.com/glotzerlab/signac-benchmarks
Benchmarks for the core signac application.
https://github.com/glotzerlab/signac-benchmarks
Last synced: about 2 months ago
JSON representation
Benchmarks for the core signac application.
- Host: GitHub
- URL: https://github.com/glotzerlab/signac-benchmarks
- Owner: glotzerlab
- License: mit
- Created: 2019-02-14T22:12:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-31T17:49:26.000Z (over 1 year ago)
- Last Synced: 2026-01-01T02:46:31.012Z (5 months ago)
- Language: Python
- Homepage: https://signac.io/
- Size: 46.9 KB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# README
## About
This repository contains scripts and one jupyter notebook to execute benchmarks for the [signac core](https://signac.readthedocs.io/) application.
In the current version, they are optionally compared against [datreant](http://datreant.org/).
Author: Carl Simon Adorf, csadorf@umich.edu
All code within this repository, except for the `tempdir.py` module, are distributed under the MIT License.
The full license text is in the `LICENSE.txt` file.
## Quickstart
To run benchmarks, first clone this repository, then execute:
```bash
./run.sh
```
This will generate a collection file called `benchmark.txt`, which contains the benchmark results.
To visualize and plot the benchmark results, execute the `report.ipynb` jupyter notebook.
## Usage
The `run_benchmark.py` script is the main benchmark execution script.
Execute `python run_benchmark.py --help` to get help on how to execute benchmarks.
For example, to run a benchmark for signac for a dataspace with 1,000 directories in the `/tmp` directory, you would execute:
```bash
python run_benchmark.py signac -N 1000 --root=/tmp
```