Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Alessandro Felder <[email protected]>
  • Loading branch information
willGraham01 and alessandrofelder authored Jan 8, 2024
1 parent 6919911 commit 1bb20ae
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/source/community/releases/v1/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
5 changes: 4 additions & 1 deletion docs/source/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:

Expand Down

0 comments on commit 1bb20ae

Please sign in to comment.