From af7935f489e1af9298281cb43fbc79b885dfbfaf Mon Sep 17 00:00:00 2001 From: Alessandro Felder Date: Thu, 14 Dec 2023 14:52:05 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: sfmig <33267254+sfmig@users.noreply.github.com> --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3aea7b8c..b6dc752c 100644 --- a/README.md +++ b/README.md @@ -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