Skip to main content

Near-real time detection of derelict (ghost) crab pots with side-scan sonar.

Project description

GhostVision

🚧UNDER CONSTRUCTION🚧

PyPI - Version GitHub last commit GitHub commit activity GitHub

Near-real time detection of derelict (ghost) crab pots with side-scan sonar.

ezgif com-crop

Overview

GhostVision is an open-source Python interface for automatically detecting and mapping ghost (derelict) crab pots from side-scan sonar imagery. GhostVision leverages Yolo models trained with Roboflow. Detections are then georeferenced with PINGMapper.

Installation

GPU (Fast Inference)

GhostVision is optimized for running inference (predictions) on the GPU. The processing environment is installed with conda. Any flavor of conda will do, but we recommend Miniforge. Follow the instructions below based on your OS.

Windows Only

Windows does not natively support inference on the GPU. A utility called WSL (Windows Subsystem for Linux) needs to be installed in order to run inference on the GPU.

  1. Install WSL (Windows Subsystem for Linux) &
  2. Open the command prompt by launching Ubuntu from the Windows Start menu.

Install Miniforge

  1. In a command prompt, download Miniforge with:
    wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
    
  2. Install Miniforge with:
    bash Miniforge3-$(uname)-$(uname -m).sh
    

Install GhostVision

  1. Install PINGInstaller:
    pip install pinginstaller
    
  2. Install GhostVision:
    python -m pinginstaller ghostvision-gpu
    

CPU (Slow Inference; Experimental)

An experimental version of GhostVision is available to test inference speeds on the CPU. This has been tested on Windows 11 only.

  1. Install Miniforge.
  2. Open the Miniforge prompt.
  3. Install PINGInstaller:
    pip install pinginstaller
    
  4. Install GhostVision.
    python -m pinginstaller ghostvision
    

Usage

  1. Open the appropriate command prompt based on your installation above.
  2. Launch GhostVision:
    conda activate ghostvision
    python -m ghostvision
    
  3. Select desired parameters and click Submit.

Download Custom Roboflow Object Detection Model

GhostVision includes Roboflow object detection models designed to detect crab pots from side-scan sonar imagery. You can train and use your own object detection model by downloading the model from Roboflow with the included utility.

  1. Open the appropriate command prompt based on your installation above.
  2. Launch the Roboflow model download utility:
    conda activate ghostvision
    python -m ghostvision rf-download
    
  3. Supply your Roboflow API Key.
  4. Enter the project name (all lowercase).
  5. Enter the project version.

The model will be downloaded and available to use.

Acknowledgments

GhostVision has been made possible through mentorship, partnerships, financial support, open-source software, manuscripts, and documentation linked below.

NOTE: The contents of this repository are those of the author(s) and do not necessarily represent the views of the individuals and organizations specifically mentioned here.

Development Team: Cameron Bodine, Art Trembanis, Kleio Baxevani, Onur Bagoren, Olivia Hines, Jared Wierzbicki, Ophelia Christoph, Catherine Hughes, Julia Greco.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ghostvision-1.0.0b2.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ghostvision-1.0.0b2-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file ghostvision-1.0.0b2.tar.gz.

File metadata

  • Download URL: ghostvision-1.0.0b2.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for ghostvision-1.0.0b2.tar.gz
Algorithm Hash digest
SHA256 82c3cc1220faa0fbc00e2e6fe3a2e6b665275f7f5cb16528f99f88b0de9046e9
MD5 e1ea7648aa19a8c0dd05663007dd557d
BLAKE2b-256 0d38704cf7e5dc7cd825698f7f7df16a99d26f6e07f8db4b41e0c91ea831d7f7

See more details on using hashes here.

File details

Details for the file ghostvision-1.0.0b2-py3-none-any.whl.

File metadata

  • Download URL: ghostvision-1.0.0b2-py3-none-any.whl
  • Upload date:
  • Size: 16.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for ghostvision-1.0.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 e2e429275a2a971b2badbafa0c09b277ed18358c1d9d948f5b4e4e631025e218
MD5 ee4fbeb271d98446917369903ef9ef30
BLAKE2b-256 d0bcec457eb5055aa99dc12e6860a50652b2ccd6ae9a9e5b2c069cfe7c0a960c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page