Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: sfmig <[email protected]>
  • Loading branch information
alessandrofelder and sfmig authored Dec 14, 2023
1 parent cd47d0e commit af7935f
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

## Main purpose of brainglobe-workflows

The main purpose of this repository is to host Python scripts and Command Line Interfaces for typical workflows that are easy for others to re-use.
The main purpose of this repository is to host Python scripts and Command Line Interfaces that capture typical workflows of the BrainGlobe tools.

These workflows should be representative of the most common use-cases and are meant to be easy to reuse. They also serve as an example of how to combine several BrainGlobe tools to achieve a goal, such as whole brain cell detection and atlas registration.
These workflows typically combine several BrainGlobe tools (possibly together with other tools) to achieve a goal,
such as whole brain cell detection and atlas registration.

## Secondary purposes of brainglobe-workflow, for developers
## Secondary purposes of brainglobe-workflows, for developers

Secondarily, this repository further has a related purposes for BrainGlobe code development itself.
Secondarily, this repository further has related purposes for BrainGlobe code development itself.
* It contains benchmarks for these workflows to ensure performance is stable as the code changes
* (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
Expand Down

0 comments on commit af7935f

Please sign in to comment.