Skip to content

Installation

Requirements

  • Python 3.10 or later
  • Optional: Chrome or Firefox browser (for screenshot automation)

Installing with pip

pip install noctua-py

Installing with uv

uv is a fast Python package manager:

uv add noctua-py

Installing from source

git clone https://github.com/geneontology/noctua-py
cd noctua-py
uv sync  # or pip install -e .

Optional Dependencies

For Screenshot Automation

To use the screenshot capture feature, install a browser and driver:

# macOS with Homebrew
brew install --cask google-chrome
brew install chromedriver

# Ubuntu/Debian
sudo apt-get install chromium-browser chromium-chromedriver

# Python packages
pip install selenium pillow

# macOS with Homebrew
brew install --cask firefox
brew install geckodriver

# Ubuntu/Debian
sudo apt-get install firefox firefox-geckodriver

# Python packages
pip install selenium pillow

For GO-CAM Conversion

To convert models to GO-CAM structured format:

pip install gocam

Verify Installation

Check that the CLI is installed:

noctua --help

Test the Python import:

from noctua import BaristaClient
print("noctua installed successfully!")

Next Steps