fathomnet

FathomNet Python client

https://github.com/fathomnet/fathomnet-py

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 7 committers (14.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.2%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

FathomNet Python client

Basic Info
Statistics
  • Stars: 34
  • Watchers: 4
  • Forks: 4
  • Open Issues: 6
  • Releases: 19
Created over 4 years ago · Last pushed 12 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

fathomnet-py

[![image](https://img.shields.io/pypi/v/fathomnet.svg)](https://pypi.python.org/pypi/fathomnet) [![image](https://img.shields.io/pypi/l/fathomnet.svg)](https://github.com/fathomnet/fathomnet-py/blob/main/LICENSE) [![CI/CD](https://github.com/fathomnet/fathomnet-py/actions/workflows/cicd.yml/badge.svg)](https://github.com/fathomnet/fathomnet-py/actions/workflows/cicd.yml) [![Documentation Status](https://readthedocs.org/projects/fathomnet-py/badge/?version=latest)](https://fathomnet-py.readthedocs.io/en/latest/?badge=latest) [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://docs.astral.sh/ruff/)

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

```python

from fathomnet.api import boundingboxes boundingboxes.findconcepts() ['2G Robotics structured light laser', '55-gallon drum', ...] from fathomnet.api import images images.findbyconcept('Nanomia') [ AImageDTO( id=2274942, uuid='cdbfca66-284f-48ac-a36f-7b2ac2b43533', url='https://database.fathomnet.org/static/m3/framegrabs/MiniROV/images/0056/02183720.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:

bash $ python -m pip install fathomnet

Examples

API Tutorial: Tutorial

FathomNet Models: Models

API Reference available on Read the Docs

Owner

  • Name: FathomNet
  • Login: fathomnet
  • Kind: organization
  • Location: United States of America

FathomNet is an open-source image database that can be used to train machine learning algorithms to help us understand our ocean and its inhabitants

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"

GitHub Events

Total
  • Create event: 6
  • Issues event: 3
  • Release event: 4
  • Watch event: 7
  • Issue comment event: 2
  • Push event: 24
  • Fork event: 1
Last Year
  • Create event: 6
  • Issues event: 3
  • Release event: 4
  • Watch event: 7
  • Issue comment event: 2
  • Push event: 24
  • Fork event: 1

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 174
  • Total Committers: 7
  • Avg Commits per committer: 24.857
  • Development Distribution Score (DDS): 0.195
Past Year
  • Commits: 22
  • Committers: 2
  • Avg Commits per committer: 11.0
  • Development Distribution Score (DDS): 0.182
Top Committers
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 (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 28
  • Total pull requests: 4
  • Average time to close issues: 2 months
  • Average time to close pull requests: about 17 hours
  • Total issue authors: 11
  • Total pull request authors: 3
  • Average comments per issue: 2.25
  • Average comments per pull request: 0.5
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 0
  • Average time to close issues: 8 days
  • Average time to close pull requests: N/A
  • Issue authors: 4
  • Pull request authors: 0
  • Average comments per issue: 1.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mi2celis (6)
  • kevinsbarnard (6)
  • eor314 (6)
  • khiyer (2)
  • Kmoran1512 (2)
  • joostdaniels (1)
  • KahnSvaer (1)
  • Sidd1609 (1)
  • asw-v4 (1)
  • csbrown (1)
  • mbergman257 (1)
Pull Request Authors
  • lauravchrobak (2)
  • eor314 (2)
  • hohonuuli (1)
Top Labels
Issue Labels
enhancement (6) bug (5) question (1) documentation (1)
Pull Request Labels
enhancement (2)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 128 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 68
  • Total maintainers: 1
proxy.golang.org: github.com/fathomnet/fathomnet-py
  • Versions: 35
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 7 months ago
pypi.org: fathomnet

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

  • Versions: 33
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 128 Last month
Rankings
Dependent packages count: 10.0%
Stargazers count: 14.2%
Average: 16.7%
Downloads: 18.3%
Forks count: 19.1%
Dependent repos count: 21.8%
Maintainers (1)
Last synced: 7 months ago

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