From 1bb20ae0c721ad083bd7da6e4591e9f7e80e33ac Mon Sep 17 00:00:00 2001 From: Will Graham <32364977+willGraham01@users.noreply.github.com> Date: Mon, 8 Jan 2024 10:26:18 +0000 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Alessandro Felder --- .../developers/repositories/brainglobe-meta/index.md | 2 +- docs/source/community/releases/v1/index.md | 2 +- docs/source/documentation/index.md | 5 ++++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/source/community/developers/repositories/brainglobe-meta/index.md b/docs/source/community/developers/repositories/brainglobe-meta/index.md index edf81415..33d4d3ed 100644 --- a/docs/source/community/developers/repositories/brainglobe-meta/index.md +++ b/docs/source/community/developers/repositories/brainglobe-meta/index.md @@ -98,4 +98,4 @@ As a general rule of thumb when editing the dependency chart, packages/tools sho Packages on the top level depend on no other BrainGlobe tools. Packages on the level below depend on at least one package from the level above, and any number of packages from the level(s) further up than that. -This illustrates both how BrainGlobe tools build on each other, as well as which tools can be considered ambivalent to new releases of others. +This illustrates both how BrainGlobe tools build on each other, as well as which tools may be affected by new releases of others. diff --git a/docs/source/community/releases/v1/index.md b/docs/source/community/releases/v1/index.md index e7a61818..fdfc338c 100644 --- a/docs/source/community/releases/v1/index.md +++ b/docs/source/community/releases/v1/index.md @@ -61,7 +61,7 @@ cellfinder-core-and-plugin-merge - The command-line tool is now called `brainmapper`. - The name "cellfinder" is now reserved for the merged `cellfinder-core` and `cellfinder-napari` packages. - `cellfinder-core` and `cellfinder-napari` have been merged into a single package, called `cellfinder`. - - The `cellfinder` package should not be confused with the old cellfinder command-line tool, described above. Going forward, "cellfinder" will refer exclusively to this new, merged package created from `cellfinder-core` and `cellfinder-napari` which only performs cell detection. The command-line tool with use the name `brainmapper`. + - The `cellfinder` package should not be confused with the old cellfinder command-line tool, described above. Going forward, "cellfinder" will refer exclusively to this new, merged package created from `cellfinder-core` and `cellfinder-napari` which only performs cell detection. The command-line tool will use the name `brainmapper`. - The `core` and `napari` features are now available as submodules of the `cellfinder` package. If you previously used `from cellfinder_core import X`, you'll have to use `from cellfinder.core import X` instead. - Internal function names and locations have otherwise not changed, beyond their conversion into the `core` and `napari` submodules. - The napari plugin is now referred to as the `cellfinder` plugin, and shows up with the name `cellfinder` when viewed in napari (as opposed to the old `cellfinder-napari` name it used to have). diff --git a/docs/source/documentation/index.md b/docs/source/documentation/index.md index 6ecf888f..1a0a45d4 100644 --- a/docs/source/documentation/index.md +++ b/docs/source/documentation/index.md @@ -3,7 +3,10 @@ ## Installing BrainGlobe We always recommend that you install BrainGlobe tools into a virtual environment (managed by software such as `conda` or `venv`). -Your environment should run Python 3.9 or 3.10. +Your environment should run Python 3.9 or 3.10. To specify the Python version for new conda environment, add it as a parameter on creation: + +```bash +conda create -n brainglobe-env python=3.10 Once you have created and activated your desired environment, you can install all BrainGlobe tools using `pip`: