Skip to content

Commit

Permalink
Clarify repo purposes
Browse files Browse the repository at this point in the history
  • Loading branch information
alessandrofelder authored Dec 11, 2023
1 parent e69e83e commit 4b2da4d
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
# brainglobe-workflows

## Purposes of brainglobe-workflows

This repository serves several related purposes
In order of importance
* host Python scripts for typical workflows that are easy for users to re-use (by e.g. copy-pasting contents and adapting paths or similar)
* implement benchmarks for these workflows to ensure performance is stable as we change the code
* (default) run benchmarks on CI with small data
* (optionally) specify a configuration (as a json file) to run benchmarks on locally available, typically "real", data
* these configurations are not intended to be user-facing

Note that to catch dependency updates breaking our code early, we additionally run and benchmark the workflows locally on a desktop machine with large example data.

0 comments on commit 4b2da4d

Please sign in to comment.