A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

fathomnet-py

An open-source image database that can be used to train, test, and validate state-of-the-art artificial intelligence algorithms to help us understand our ocean and its inhabitants.
https://github.com/fathomnet/fathomnet-py

Category: Biosphere
Sub Category: Marine Life and Fishery

Keywords from Contributors

profiles weather-station

Last synced: about 3 hours ago
JSON representation

Repository metadata

FathomNet Python client

README.md

fathomnet-py

image
image
CI/CD
Documentation Status
uv
Ruff

fathomnet-py is a client-side API to help scientists, researchers, and developers interact with FathomNet Database data.

>>> from fathomnet.api import boundingboxes
>>> boundingboxes.find_concepts()
['2G Robotics structured light laser', '55-gallon drum', ...]
>>> from fathomnet.api import images
>>> images.find_by_concept('Nanomia')
[
    AImageDTO(
        id=2274942, 
        uuid='cdbfca66-284f-48ac-a36f-7b2ac2b43533', 
        url='https://database.fathomnet.org/static/m3/framegrabs/MiniROV/images/0056/02_18_37_20.png', 
        ...
    ),
    ...
]
>>> from fathomnet.api import taxa
>>> taxa.find_children('mbari', 'Bathochordaeus')
[
    Taxa(name='Bathochordaeus stygius', rank='species'), 
    Taxa(name='Bathochordaeus charon', rank='species'), 
    Taxa(name='Bathochordaeus mcnutti', rank='species')
]
>>> from fathomnet.api import xapikey
>>> xapikey.auth('NuCLjlNUlgHchtgDB01Sp1fABJVcWR')  # your API key here
AuthHeader(
    type='Bearer', 
    token='eyJhbGciOiJI...'
)

The fathomnet-py API offers native Python interaction with the FathomNet REST API, abstracting away the underlying HTTP requests.

Installing fathomnet-py

fathomnet-py is available on PyPI:

$ python -m pip install fathomnet

Examples

API Tutorial: Tutorial

FathomNet Models: Models

API Reference available on Read the Docs

Citation (CITATION.cff)

cff-version: 1.2.0
title: "fathomnet-py"
authors:
  - family-names: Barnard
    given-names: Kevin
type: software
message: "If you use this software, please cite both the article from preferred-citation and the software itself."
preferred-citation:
  type: article
  authors:
    - family-names: Katija
      given-names: Kakani
    - family-names: Orenstein
      given-names: Eric
    - family-names: Schlining
      given-names: Brian
    - family-names: Lundsten
      given-names: Lonny
    - family-names: Barnard
      given-names: Kevin
    - family-names: Sainz
      given-names: Giovanna
    - family-names: Boulais
      given-names: Oceane
    - family-names: Cromwell
      given-names: Megan
    - family-names: Butler
      given-names: Erin
    - family-names: Woodward
      given-names: Benjamin
    - family-names: Bell
      given-names: Katherine L. C.
  title: "FathomNet: A global image database for enabling artificial intelligence in the ocean"
  journal: "Scientific Reports"
  volume: "12"
  issue: "1"
  year: 2022
  date-released: "2022-09-23"
  pages: "15914"
  doi: "10.1038/s41598-022-19939-2"
  url: "https://doi.org/10.1038/s41598-022-19939-2"

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 174
Total Committers: 7
Avg Commits per committer: 24.857
Development Distribution Score (DDS): 0.195

Commits in past year: 37
Committers in past year: 3
Avg Commits per committer in past year: 12.333
Development Distribution Score (DDS) in past year: 0.243

Name Email Commits
Kevin Barnard k****d@m****g 140
ecor e****n@m****g 10
semantic-release s****e 10
github-actions g****s@g****m 9
eor314 e****t@u****u 3
lauravchrobak l****k@m****g 1
Brian Schlining b****g@g****m 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 26
Total pull requests: 4
Average time to close issues: 2 months
Average time to close pull requests: about 17 hours
Total issue authors: 9
Total pull request authors: 3
Average comments per issue: 2.38
Average comments per pull request: 0.5
Merged pull request: 4
Bot issues: 0
Bot pull requests: 0

Past year issues: 3
Past year pull requests: 1
Past year average time to close issues: 10 days
Past year average time to close pull requests: 25 minutes
Past year issue authors: 3
Past year pull request authors: 1
Past year average comments per issue: 1.33
Past year average comments per pull request: 1.0
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/fathomnet/fathomnet-py

Top Issue Authors

  • mi2celis (6)
  • kevinsbarnard (6)
  • eor314 (6)
  • khiyer (2)
  • Kmoran1512 (2)
  • Sidd1609 (1)
  • asw-v4 (1)
  • csbrown (1)
  • mbergman257 (1)

Top Pull Request Authors

  • eor314 (2)
  • hohonuuli (1)
  • lauravchrobak (1)

Top Issue Labels

  • enhancement (6)
  • bug (5)
  • question (1)
  • documentation (1)

Top Pull Request Labels

  • enhancement (2)

Package metadata

pypi.org: fathomnet

fathomnet-py is a client-side API to help scientists, researchers, and developers interact with FathomNet data.

  • Homepage: https://database.fathomnet.org/fathomnet/#/about
  • Documentation: https://fathomnet-py.readthedocs.io
  • Licenses: MIT License
  • Latest release: 1.8.1 (published 20 days ago)
  • Last Synced: 2025-04-27T06:02:08.356Z (1 day ago)
  • Versions: 33
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 1,344 Last month
  • Rankings:
    • Dependent packages count: 9.975%
    • Stargazers count: 14.205%
    • Average: 16.684%
    • Downloads: 18.322%
    • Forks count: 19.149%
    • Dependent repos count: 21.769%
  • Maintainers (1)

Dependencies

pyproject.toml pypi
  • coco-lib ^0.1.2
  • dataclasses-json ^0.5.4
  • lxml ^4.6.0
  • progressbar2 ^3.37.0
  • python ^3.7
  • requests ^2.20.0

Score: 12.734321597716097