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 24 hours ago
JSON representation
Repository metadata
FathomNet Python client
- Host: GitHub
- URL: https://github.com/fathomnet/fathomnet-py
- Owner: fathomnet
- License: mit
- Created: 2021-08-23T21:23:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-09T06:05:59.000Z (9 months ago)
- Last Synced: 2025-11-21T12:03:54.296Z (about 1 month ago)
- Language: Python
- Homepage: https://fathomnet-py.readthedocs.io
- Size: 337 KB
- Stars: 34
- Watchers: 4
- Forks: 4
- Open Issues: 5
- Releases: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Citation: CITATION.cff
README.md
fathomnet-py
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: 
FathomNet 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
- Name: FathomNet
- Login: fathomnet
- Email:
- Kind: organization
- Description: 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
- Website: www.fathomnet.org
- Location: United States of America
- Twitter: fathomnet
- Company:
- Icon url: https://avatars.githubusercontent.com/u/77417933?v=4
- Repositories: 4
- Last ynced at: 2023-03-11T08:36:28.350Z
- Profile URL: https://github.com/fathomnet
GitHub Events
Total
- Create event: 6
- Issues event: 4
- Release event: 5
- Watch event: 7
- Issue comment event: 2
- Push event: 26
- Fork event: 1
Last Year
- Create event: 3
- Issues event: 4
- Release event: 3
- Watch event: 2
- Issue comment event: 2
- Push event: 15
Committers metadata
Last synced: 2 days ago
Total Commits: 177
Total Committers: 7
Avg Commits per committer: 25.286
Development Distribution Score (DDS): 0.198
Commits in past year: 12
Committers in past year: 2
Avg Commits per committer in past year: 6.0
Development Distribution Score (DDS) in past year: 0.25
| Name | Commits | |
|---|---|---|
| Kevin Barnard | k****d@m****g | 142 |
| semantic-release | s****e | 11 |
| ecor | e****n@m****g | 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:
- mbari.org: 3
- ucsd.edu: 1
- github.com: 1
Issue and Pull Request metadata
Last synced: 16 days ago
Total issues: 29
Total pull requests: 6
Average time to close issues: 2 months
Average time to close pull requests: about 14 hours
Total issue authors: 12
Total pull request authors: 4
Average comments per issue: 2.1
Average comments per pull request: 0.5
Merged pull request: 5
Bot issues: 0
Bot pull requests: 0
Past year issues: 5
Past year pull requests: 1
Past year average time to close issues: about 1 month
Past year average time to close pull requests: N/A
Past year issue authors: 5
Past year pull request authors: 1
Past year average comments per issue: 0.8
Past year average comments per pull request: 0.0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top 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)
- csbrown-noaa (1)
Top Pull Request Authors
- eor314 (2)
- lauravchrobak (2)
- hohonuuli (1)
- csbrown-noaa (1)
Top Issue Labels
- enhancement (6)
- bug (5)
- question (1)
- documentation (1)
Top Pull Request Labels
- enhancement (2)
Package metadata
- Total packages: 2
-
Total downloads:
- pypi: 563 last-month
- Total dependent packages: 0 (may contain duplicates)
- Total dependent repositories: 1 (may contain duplicates)
- Total versions: 70
- Total maintainers: 1
proxy.golang.org: github.com/fathomnet/fathomnet-py
- Homepage:
- Documentation: https://pkg.go.dev/github.com/fathomnet/fathomnet-py#section-documentation
- Licenses: mit
- Latest release: v1.9.0 (published 6 days ago)
- Last Synced: 2025-12-22T03:05:54.862Z (4 days ago)
- Versions: 36
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
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.9.0 (published 6 days ago)
- Last Synced: 2025-12-22T03:05:51.396Z (4 days ago)
- Versions: 34
- Dependent Packages: 0
- Dependent Repositories: 1
- Downloads: 563 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
- 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: 11.946297526331401