oplab-pipeline

parsers for navigation data for oplab_standard and acfr_standard formats

https://github.com/ocean-perception/oplab_pipeline

Science Score: 85.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
    Found 2 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    8 of 22 committers (36.4%) from academic institutions
  • Institutional organization owner
    Organization ocean-perception has institutional domain (ocean.soton.ac.uk)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

parsers for navigation data for oplab_standard and acfr_standard formats

Basic Info
  • Host: GitHub
  • Owner: ocean-perception
  • License: other
  • Language: Python
  • Default Branch: master
  • Size: 9.67 MB
Statistics
  • Stars: 10
  • Watchers: 6
  • Forks: 1
  • Open Issues: 24
  • Releases: 13
Created over 8 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog License Citation

README.md

oplab_pipeline CC BY-NC-SA 4.0 Code Coverage Documentation Status Docker Image CI DOI

oplab_pipeline

oplab_pipeline is a python toolchain to process AUV dives from raw data into navigation and imaging products. The software is capable of:

  • Process navigation: fuses AUV or ROV sensor data using state of the art filters and geolocalises recorded imagery.
  • Camera and laser calibration: performs automatic calibration pattern detection to calibrate monocular or stereo cameras. Also calibrates laser sheets with respect to the cameras.
  • Image correction: performs pixel-wise image corrections to enhance colour and contrast in underwater images.

Please review the latest changes in the CHANGELOG.md.

Installation

For production, to install this package run: bash pip install -U git+https://github.com/ocean-perception/oplab_pipeline.git

This will make the commands auv_nav, auv_cal and correct_images available in the terminal. For more details refer to the documentation.

For development, clone the repository, navigate to the oplab-pipeline folder and run bash pip install -U --user -e .

Notes:

To import rosbag, using pip install baypy. (see the docs: https://jmscslgroup.github.io/bagpy/)

Documentation

The documentation is hosted in read the docs.

Citation

If you use this software, please cite the following article:

Yamada, T, Prügel‐Bennett, A, Thornton, B. Learning features from georeferenced seafloor imagery with location guided autoencoders. J Field Robotics. 2020; 1– 16. https://doi.org/10.1002/rob.21961

License

Copyright (c) 2020-2022, University of Southampton. All rights reserved. This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

See LICENSE.md file in the project root for full license information.

Contributing

Please document the code using Numpy Docstrings. If you are using VSCode, there is a useful extension that helps named Python Docstring Generator. Once installed, make sure you select Numpy documentation in the settings.

Run pre-commit install to install pre-commit into your git hooks. pre-commit will now run on every commit. If you don't have pre-commit installed, run pip install pre-commit.

Owner

  • Name: ocean-perception
  • Login: ocean-perception
  • Kind: organization
  • Email: b.thornton@soton.ac.uk

University of Southampton and University of Tokyo repositories for autonomous robotics, sensing and intelligence for seabed surveys.

Citation (CITATION.cff)

cff-version: 1.2.0
message: 'If you use this software, please cite it as below.'
title: >-
  Ocean Perception Laboratory Pipeline
  (oplab_pipeline)
version: 1.0.0
doi: 10.5281/zenodo.6623369
date-released: 2022-06-08
type: software
authors:
  - given-names: Miguel Massot
    name-particle: Miguel
    family-names: Massot Campos
    email: miquel.massot-campos@soton.ac.uk
    affiliation: University of Southampton
    orcid: 'https://orcid.org/0000-0002-1202-0362'
  - given-names: Adrian Bodenmann
    name-particle: Adrian
    family-names: Bodenmann
    email: adrian.bodenmann@soton.ac.uk
    affiliation: University of Southampton
    orcid: 'https://orcid.org/0000-0002-3195-0602'
  - given-names: Blair Thornton
    name-particle: Blair
    family-names: Thornton
    email: b.thornton@soton.ac.uk
    affiliation: University of Southampton
    orcid: 'https://orcid.org/0000-0003-4492-622X'

GitHub Events

Total
  • Create event: 17
  • Commit comment event: 2
  • Release event: 1
  • Issues event: 1
  • Watch event: 1
  • Delete event: 12
  • Issue comment event: 5
  • Push event: 18
  • Pull request event: 23
Last Year
  • Create event: 17
  • Commit comment event: 2
  • Release event: 1
  • Issues event: 1
  • Watch event: 1
  • Delete event: 12
  • Issue comment event: 5
  • Push event: 18
  • Pull request event: 23

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 1,693
  • Total Committers: 22
  • Avg Commits per committer: 76.955
  • Development Distribution Score (DDS): 0.438
Top Committers
Name Email Commits
Miquel Massot m****t@g****m 952
Adrian a****n@s****k 167
cappelletto c****o@g****m 98
Subhra K. Das s****s@s****k 84
Lim J.W j****7@s****k 65
SubhraKDas1982 4****2@u****m 63
David Stanley d****y@s****k 58
blair b****n@s****k 37
JennyLouise j****r@l****k 30
subhra_k.das@soton.ac.uk s****a@D****n 29
Adrian a****n@i****p 27
Takaki-YAMADA t****d@g****m 20
Blair-insitu B****n@s****k 18
Blair Thornton B****u@g****m 16
dependabot[bot] 4****]@u****m 8
JinLim j****2@h****m 7
SubhraKDas19 s****2@g****m 4
Miquel Massot m****t@g****n 4
your_name y****l@a****m 2
Adrian Bodenmann 2****n@u****m 2
Rugged Biocam m****s@s****k 1
Unknown u****l@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 68
  • Total pull requests: 105
  • Average time to close issues: 4 months
  • Average time to close pull requests: 26 days
  • Total issue authors: 5
  • Total pull request authors: 9
  • Average comments per issue: 0.9
  • Average comments per pull request: 0.7
  • Merged pull requests: 56
  • Bot issues: 0
  • Bot pull requests: 88
Past Year
  • Issues: 1
  • Pull requests: 27
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 month
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.37
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 27
Top Authors
Issue Authors
  • adrian-bodenmann (34)
  • miquelmassot (17)
  • cappelletto (12)
  • JennyLouise (3)
  • Blair-insitu (2)
  • dependabot[bot] (1)
Pull Request Authors
  • dependabot[bot] (111)
  • miquelmassot (8)
  • DavidStanley94 (3)
  • adrian-bodenmann (2)
  • Cailei0412 (2)
  • umeshn (1)
  • cappelletto (1)
  • ArjanAttwal (1)
  • JennyLouise (1)
Top Labels
Issue Labels
enhancement (16) bug (15) easy (2) help wanted (2) dependencies (1)
Pull Request Labels
dependencies (111) github_actions (7) enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 59 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 10
  • Total maintainers: 2
pypi.org: oplab-pipeline

Toolchain for AUV dive processing, camera calibration and image correction

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 59 Last month
Rankings
Dependent packages count: 10.1%
Stargazers count: 16.6%
Downloads: 16.8%
Average: 17.5%
Dependent repos count: 21.6%
Forks count: 22.7%
Maintainers (2)
Last synced: 7 months ago

Dependencies

requirements.txt pypi
  • PyYAML >=3.12
  • argcomplete >=1.12.3
  • argparse >=1.1
  • colour_demosaicing >=0.1.5
  • geographiclib >=1.50
  • imageio >=2.6.1
  • joblib >=0.14.1
  • matplotlib >=3.1.2
  • numba *
  • numpy >=1.17.3
  • opencv-python-headless >=4.1.2
  • pandas >=0.25.3
  • pillow >=7.0.0
  • plotly >=4.4.1
  • plyfile >=0.7.2
  • pre-commit >=2.14.0
  • prettytable >=0.7.2
  • psutil >=5.5.1
  • pynmea2 >=1.15.0
  • pytz >=2019.3
  • recommonmark >=0.6.0
  • scikit-image >=0.17.2
  • scipy >=1.4.1
  • setuptools *
  • sphinx_rtd_theme >=0.4.3
  • tqdm >=4.30.0
  • wheel >=0.30.0
setup.py pypi
  • PyYAML >=3.12
  • argcomplete >=1.12.3
  • argparse >=1.1
  • colour_demosaicing >=0.1.5
  • geographiclib >=1.50
  • imageio >=2.6.1
  • joblib >=0.14.1
  • matplotlib >=3.2.1
  • numba >=0.51.2
  • numpy >=1.17.3
  • opencv-python-headless >=4.1.2
  • pandas >=0.25.3
  • pillow >=7.2.0
  • plotly >=4.7.1
  • plyfile >=0.7.2
  • prettytable >=0.7.2
  • psutil >=5.8.0
  • pynmea2 >=1.15.0
  • pytz >=2019.3
  • scikit_image >=0.17
  • scipy >=1.4.1
  • tqdm >=4.40.2
  • wheel >=0.30.0
.github/workflows/docker_image.yml actions
  • actions/checkout v3.3.0 composite
  • docker/build-push-action 37abcedcc1da61a57767b7588cb9d03eb57e28b3 composite
  • docker/login-action 49ed152c8eca782a232dede0303416e8f356c37b composite
  • docker/metadata-action 507c2f2dc502c992ad446e3d7a5dfbe311567a96 composite
.github/workflows/oplab_pipeline.yml actions
  • actions/checkout v3.3.0 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
.github/workflows/publish_to_pypi.yml actions
  • WyriHaximus/github-action-get-previous-tag v1 composite
  • actions/checkout v3.3.0 composite
  • actions/setup-python v4 composite
Dockerfile docker
  • python 3.10-slim-bullseye build
docs/requirements.txt pypi
  • PyYAML >=3.12
  • argcomplete >=1.12.3
  • argparse >=1.1
  • colour_demosaicing >=0.1.5
  • geographiclib >=1.50
  • imageio >=2.6.1
  • joblib >=0.14.1
  • matplotlib >=3.1.2
  • numba >=0.56.4
  • numpy >=1.23.0
  • pandas >=0.25.3
  • pillow >=7.0.0
  • plotly >=4.4.1
  • plyfile >=0.7.2
  • pre-commit >=2.14.0
  • prettytable >=3.5.0
  • psutil >=5.5.1
  • pynmea2 >=1.15.0
  • pytz >=2019.3
  • recommonmark >=0.6.0
  • scikit-image >=0.17.2
  • scipy >=1.4.1
  • setuptools >=65.5.1
  • sphinx_rtd_theme >=0.4.3
  • tqdm >=4.64.0
  • wheel >=0.30.0