Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

Update README in light of possible noarch build #191

Merged
merged 1 commit into from
Jul 5, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,16 @@ N.B. To speed up cellfinder, you need CUDA & cuDNN installed. Instructions
[here](https://brainglobe.info/documentation/general/gpu.html).

#### Conda Install
`cellfinder-core` is available on `conda-forge`, however `tensorflow`, one of it's core dependencies, is not.
As a result; you _must_ manually install `tensorflow` into your environment - whether you do this before or after `conda install`ing doesn't matter.
Once you are ready, install `cellfinder-core` into the desired environment via conda;
Linux and MacOS users can also install `cellfinder-core` from `conda-forge`, by running
```sh
conda install -c conda-forge cellfinder-core
```

Please bear in mind that running the `conda install` command above will exit without failing even if `tensorflow` is not present; however `tensorflow` will not be installed as part of this process, and thus `cellfinder-core` will not be usable.
Windows users can also use the command above to install `cellfinder-core`, however `tensorflow` (one of `cellfinder-core`'s core dependencies) is not available so will not be included.
Consequentially, `cellfinder-core` will be usable - you will get `PackageNotFound` errors when attempting to import.
To rectify this, Windows users _must_ [manually install `tensorflow`](#manual-tensorflow-installations) (and ensure their Python interpreter can see this install) for `cellfinder-core` to work.
Please refer to the [`tensorflow` install page](https://www.tensorflow.org/install) for further guidance.
Whether `tensorflow` is installed before or after `conda install`ing `cellfinder-core` shouldn't matter, so long as `tensorflow` is visible to the Python interpreter.

### Usage
Before using cellfinder-core, it may be useful to take a look at the
Expand Down