Skip to content

InstallOmega

Loic A. Royer edited this page May 9, 2024 · 7 revisions

Installation from within napari:

  1. First, install a recent version of napari and check these instructions for the different options. IMPORTANT NOTE: Make sure you have a recent version of napari! Ideally, the latest one!

  2. Open the Plugins installation/removal dialog in the "Plugins>Install/Uninstall Plugins" menu:

image
  1. Install the napari-chatgpt plugin by searching it in the list:
image

Installation in a new conda environment (RECOMMENDED):

Make sure you have a miniconda installation on your system. Ask ChatGPT what that is all about if you are unsure ;-)

Make sure that your conda installation is up-to-date:

conda deactivate
conda update conda

Create environment:

conda create -y -n napari-chatgpt -c conda-forge python=3.9

Activate environment:

conda activate napari-chatgpt 

Install napari in the environment using conda-forge: (very important on Apple M1/M2)

conda install -c conda-forge napari pyqt

Or, with pip (linux, windows, or Intel Macs, not recommended on Apple M1/M2!):

python -m pip install "napari[all]"

Install napari-chatgpt in the environment:

python -m pip install napari-chatgpt

You can now start Omega's plugin within napari directly with this:

napari -w napari-chatgpt

Installation variations:

To install the latest development version (not recommended for end-users):

conda create -y -n napari-chatgpt -c conda-forge python=3.9
conda activate napari-chatgpt
python -m pip install "napari[all]"
git clone https://github.com/royerlab/napari-chatgpt.git
cd napari-chatgpt
pip install -e .
pip install -e ".[testing]"

or:

# same steps as above (except last two pip install lines) and then:
pip install git+https://github.com/royerlab/napari-chatgpt.git

On ARM Macs you can also do this to be able to run the tests locally:

pip install tox pytest pytest-cov pytest-qt

System-specific tweaks:

On Ubuntu systems, I recommend setting changing the UI timeout, otherwise, whenever Omega is thinking, the UI will freeze, and a popup will block everything which is very annoying:

gsettings set org.gnome.mutter check-alive-timeout 60000

Segmentation tools:

To segment images using CellPose or Stardist from within Omega, we recommend that you install these packages. Instructions on how to do so can be found [here | SegmentationTool].