Skip to main content

CoralNet-Toolbox 🪸🧰

CoralNet-Toolbox

AI-Powered Annotation for Coral Reef Analysis. An unofficial toolkit to supercharge your CoralNet workflows.

Python Version Version GitHub last commit Downloads

PyPI Passing Windows macOS Ubuntu

Marine imaging technology is advancing rapidly, capturing more data than ever before. To keep pace, the instinct of the tech industry is often to build entirely new, fully automated pipelines that disrupt how scientists naturally work. However, this ignores the reality of ecological research: laboratories already rely on stringent standards, deeply established protocols, and decades of domain expertise. CoralNet-Toolbox recognizes that the goal shouldn't be to force a new way of working, but to respect and protect the processes that already yield rigorous scientific results.

⚡ Get Started

1. Create Conda Environment (Recommended)

# Create and activate custom environment
conda create --name coralnet10 python=3.10 -y
conda activate coralnet10

# Install uv
pip install uv

2. (Optional) GPU Acceleration If you have an NVIDIA GPU with CUDA, install PyTorch with CUDA support for full acceleration.

# Example for CUDA 12.8 for a NVIDIA 5090 (blackwell); use your version of CUDA
uv pip install torch torchvision --index-url https://download.pytorch.org/whl/cu128

3. Install

# Use UV for the fastest installation
uv pip install coralnet-toolbox

Fallback: If UV fails, use regular pip: pip install coralnet-toolbox

4. Launch

coralnet-toolbox

🎯 GPU Status Indicators

  • 🐢 CPU only
  • 🐇 Single GPU
  • 🚀 Multiple GPUs
  • 🍎 Mac Metal (Apple Silicon)

Click the icon in the bottom-left to see available devices

⚠️ Platform-Specific Notes

macOS Users

Version 1.0.0 and greater relies heavily on a package (PyQtADS) that cannot be installed on your operating system. Please do not upgrade from 0.0.105 until this is resolved. Instead, use Docker for installation — see the Installation Guide for details.

🔧 Running into Issues?

Upgrading

# Upgrade coralnet-toolbox only (without upgrading other packages)
uv pip install --upgrade coralnet-toolbox

Note: Using -U or --upgrade-all upgrades all packages, which may trigger a regression to the CPU version of torch. To avoid this, use the command above to upgrade only coralnet-toolbox. If you do experience a regression, use pip to uninstall torch and torchvision, then re-install the CUDA version.

Removing Packages

To remove a problematic package, type the following:

uv pip uninstall package-name-here

Starting Fresh (New Environment)

To delete an old environment and create a fresh one:

# Deactivate if already in the environment
conda deactivate coralnet10

# Delete the old environment
conda env remove --name coralnet10

# Confirm when prompted
y

# Create a new environment (see "Get Started" section above for details)
conda create --name coralnet10 python=3.10 -y
conda activate coralnet10
pip install uv
uv pip install coralnet-toolbox

📚 Resources & Advanced Details

📺 Watch the Demo Videos

Video Tutorial Series

🎬 Complete playlist covering all major features and workflows

From Bottleneck to Pipeline

Traditional benthic imagery analysis is time-consuming. Manual annotation, data management, and model training are often separate, complex tasks. CoralNet-Toolbox unifies this process, turning a research bottleneck into an integrated, AI-accelerated pipeline.

📝 Core Annotation Tools

Patch Annotation
🎯 Patch Annotation
Rectangle Annotation
📐 Rectangle Annotation
Polygon Annotation
🔷 Multi-Polygon Annotation

🤖 AI-Powered Analysis

Classification
🧠 Image Classification
Object Detection
🎯 Object Detection
Instance Segmentation
🎭 Instance Segmentation

🔬 Advanced Capabilities

SAM
🪸 Segment Anything (SAM)
Polygon Classification
🔍 Polygon Classification
Work Areas
📍 Region-based Detection

✂️ Editing & Processing Tools

Cut Tool
✂️ Cut
Combine Tool
🔗 Combine
Simplify Tool
🎨 Simplify

🌊 Success Stories

Using CoralNet-Toolbox in your research?

We'd love to feature your work! Share your success stories to help others learn and get inspired.


🌍 About CoralNet

Coral reefs are among Earth's most biodiverse ecosystems, supporting marine life and coastal communities worldwide. However, they face unprecedented threats from climate change, pollution, and human activities.

CoralNet is a revolutionary platform enabling researchers to:

  • Upload and analyze coral reef photographs
  • Create detailed species annotations
  • Build AI-powered classification models
  • Collaborate with the global research community

The CoralNet-Toolbox extends this mission by providing advanced AI tools that accelerate research and improve annotation quality.


📄 Citation

If you use CoralNet-Toolbox in your research, please cite:

@misc{CoralNet-Toolbox,
  author = {Pierce, Jordan and Battista, Tim and Sandin, Stuart and Kuester, Falko},
  title = {CoralNet-Toolbox: Human-in-the-Loop Annotation and Model Development for Benthic Imagery},
  year = {2025},
  howpublished = {\url{https://github.com/Jordan-Pierce/CoralNet-Toolbox}},
  note = {GitHub repository}
}

⚠️ Disclaimer

This is a scientific product and not official communication of NOAA or the US Department of Commerce. All code is provided 'as is' - users assume responsibility for its use.

📋 License

Software created by US Government employees is not subject to copyright in the United States (17 U.S.C. §105). The Department of Commerce reserves rights to seek copyright protection in other countries.


Empowering researchers • Protecting ecosystems • Advancing science

Release files for coralnet-toolbox 1.0.15

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for coralnet-toolbox 1.0.15
File Size Uploaded
coralnet_toolbox-1.0.15.tar.gz 1.4 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for coralnet-toolbox 1.0.15
File Interpreter ABI Platform
coralnet_toolbox-1.0.15-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 2.8 MB

Release files / coralnet_toolbox-1.0.15.tar.gz

Download URL coralnet_toolbox-1.0.15.tar.gz
Size 1.4 MB
Tags Source
SHA-256 checksum
How to use checksums
14f85195218f536d4d18fcb86379870e54a0230a9e687ab0048999aa4afc2793
BLAKE2b-256 checksum
How to use checksums
450b55168125b4d421c380284cfe803e727a48312a8609c2531875a87b68082f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / coralnet_toolbox-1.0.15-py2.py3-none-any.whl

Download URL coralnet_toolbox-1.0.15-py2.py3-none-any.whl
Size 1.4 MB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
0358e44cb07620c112824a90a09f0d4cb2e2436540fc1d5ece298ed5fc12e1fe
BLAKE2b-256 checksum
How to use checksums
07d47bb22886e4083b2d729c4dd091eec1187c8cb6ccbda56c5930fe305698cf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

1.0.16

2 release files

This release

1.0.15 This release

2 release files

1.0.14

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.0.99

2 release files

0.0.97

2 release files

0.0.96

2 release files

0.0.95

2 release files

0.0.94

2 release files

0.0.93

2 release files

0.0.88

2 release files

0.0.87

2 release files

0.0.86

2 release files

0.0.85

2 release files

0.0.84

2 release files

0.0.83

2 release files

0.0.80

2 release files

0.0.79

2 release files

0.0.78

2 release files

0.0.75

2 release files

0.0.74

2 release files

0.0.72

2 release files

0.0.71

2 release files

0.0.70

2 release files

0.0.69

2 release files

0.0.66

2 release files

0.0.65

2 release files

0.0.64

2 release files

0.0.63

2 release files

0.0.62

2 release files

0.0.61

2 release files

0.0.60

1 release file

0.0.59

1 release file

0.0.56

2 release files

0.0.55

2 release files

0.0.54

2 release files

0.0.53

2 release files

0.0.52

2 release files

0.0.51

2 release files

0.0.50

2 release files

0.0.48

2 release files

0.0.47

2 release files

0.0.46

2 release files

0.0.45

2 release files

0.0.44

2 release files

0.0.43

2 release files

0.0.42

2 release files

0.0.41

1 release file

0.0.40

2 release files

0.0.35

2 release files

0.0.34

2 release files

0.0.33

2 release files

0.0.32

2 release files

0.0.31

2 release files

0.0.30

2 release files

0.0.29

2 release files

0.0.28

2 release files

0.0.27

2 release files

0.0.26

2 release files

0.0.25

2 release files

0.0.24

2 release files

0.0.23

2 release files

0.0.22

2 release files

0.0.19

2 release files

0.0.18

2 release files

0.0.17

2 release files

0.0.16

2 release files

0.0.15

2 release files

0.0.14

2 release files

0.0.13

2 release files

0.0.12

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page