Skip to content
Snippets Groups Projects

change readme description to standard pip install

Merged swainlab requested to merge mm into master
1 file
+ 17
12
Compare changes
  • Side-by-side
  • Inline
+ 17
12
@@ -23,23 +23,17 @@ bright-field images of budding cells through identifying overlaps. eLife.
We recommend installing BABY and all its requirements in a virtual environment
(e.g., `conda create` if you are using Anaconda, or `python3 -m venv` otherwise).
If you do not have a GPU and simply wish to use the latest compatible versions
of all packages, BABY can be installed by first obtaining this repository
(e.g., `git clone https://git.ecdf.ed.ac.uk/jpietsch/baby.git`), and then
using pip:
NB: If you want to install with GPU support see below.
```bash
> pip install baby/
```
NB: You can update by running: `pip install -U baby/`.
*Developers:* You may prefer to install an editable version:
Otherwise, if you simply wish to use install with the latest compatible versions
of all packages, then simply run the following in your virtual environment:
```bash
> pip install -e baby/
> pip install baby-seg
```
NB: You can update by running: `pip install -U baby-seg`.
### Python and TensorFlow version
BABY requires Python 3 and [TensorFlow](https://www.tensorflow.org).
@@ -69,6 +63,17 @@ BABY can make use of Metal on M1/M2 Macs by following the instructions
[here](https://developer.apple.com/metal/tensorflow-plugin/).
### For developers
You may prefer to install an editable version by first obtaining this repo and
then pip installing the cloned directory:
```bash
> git clone https://git.ecdf.ed.ac.uk/swain-lab/baby.git
> cd baby
> pip install -e .
```
## Quickstart using the Python API
The BABY algorithm makes use of several machine learning models that are
Loading