Skip to content

Commit

Permalink
Update the Installation Options for the Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
healthonrails committed Apr 25, 2024
1 parent daeb62c commit c653ab3
Showing 1 changed file with 18 additions and 25 deletions.
43 changes: 18 additions & 25 deletions book/content/how_to_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,63 +2,56 @@

To run Annolid, we suggest using Anaconda package/environment manager for Python. Download and install the [Anaconda](https://www.anaconda.com/products/individual) environment first. Then do the following, using the bash shell in Linux or the conda command line (= Anaconda Prompt) in Windows.

```{note}
We also provide a pypi version of Annaconda that you can use but it is most likely not an as up-to-date version of the code as the codebase on Github (at least for the foreseable future)
```
We also provide a PyPI version of Annolid that you can use, but it may not be as up-to-date as the codebase on GitHub.

## Requirements
- Ubuntu / macOS / Windows \
- Python >= 3.7 \
- Ubuntu / macOS / Windows
- Python >= 3.10
- [PyQt4 / PyQt5]

## Install Annolid locally

We create a virtual environment called _annolid-env_ into which we will install Annolid and all of its dependencies, along with whatever other Python tools we need. Python 3.7 is recommended, as it is the version being used for Annolid development.
We create a virtual environment called _annolid-env_ into which we will install Annolid and all of its dependencies, along with whatever other Python tools we need. Python 3.11 is recommended, as it is the version being used for Annolid development.

### Clone Annolid repository and change into the directory
```
conda create -n annolid-env python=3.11
conda activate annolid-env
conda install git
conda install ffmpeg
git clone --recurse-submodules https://github.com/healthonrails/annolid.git
cd annolid
pip install -e .
```
### Installing with Anaconda
```
conda env create -f environment.yml
```

```{note}
Note: if you got this error:
`ERROR: Could not find a version that satisfies the requirement decord>=0.4.0` try to install [ffmpeg](https://ffmpeg.org/) or you can install it in conda with `conda install -c conda-forge ffmpeg` and then install [decord](https://github.com/dmlc/decord) from source.
```

```{note}
Alternatively you can install with pip if you prefer using
`pip install -e .`
Note: If you encounter this error: `ERROR: Could not find a version that satisfies the requirement decord>=0.4.0`, try to install [ffmpeg](https://ffmpeg.org/) or you can install it in conda with `conda install -c conda-forge ffmpeg`, and then install [decord](https://github.com/dmlc/decord) from source.
```

```{note}
On Windows, if you encounter errors for pycocotools, please download and install [Visual studio 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=16). Then please run the following command in your terminal. `pip install "git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI"`
On Windows, if you encounter errors related to pycocotools, please download and install [Visual Studio 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=16). Then, run the following command in your terminal: `pip install "git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI"`
```

```{note}
To fix the error, `“Failed to load platform plugin “xcb”` while launching qt5 app on Linux run `sudo apt install --reinstall libxcb-xinerama0`
To fix the error `“Failed to load platform plugin “xcb”`, while launching the Qt5 app on Linux, run `sudo apt install --reinstall libxcb-xinerama0`.
```

We then activate the virtual environment we just created.
```
conda activate annolid-env
```

```{note}
Be sure to activate the annolid virtual environment every time you restart Anaconda or your computer; the shell prompt should read "(annolid-env)"
Be sure to activate the Annolid virtual environment every time you restart Anaconda or your computer; the shell prompt should read "(annolid-env)".
```

Finally to open Annolid GUI, just type the following :
Finally, to open the Annolid GUI, just type the following:
```
annolid
```

For detailed installation instructions, please check [Annolid Installation and Quick Start (PDF)](https://annolid.com/assets/pdfs/install_annolid.pdf).

# The following section is optional.
## Install Detectron2 locally only for training custom Mask R-CNN models and video inferences.

## Install Detectron2 locally
::::{Important}
If you intend to process your tagged videos using Google Colab (which you should do unless you are using a workstation with a higher-end GPU), then you do not need to install Detectron2 on your local machine, and you can ignore this section.
::::
Expand Down

0 comments on commit c653ab3

Please sign in to comment.