Skip to content
@themachinethatgoesping

themachinethatgoesping

Enable advanced processing for multibeam and singlebeam echosounder data.
Python versions 3.10 | 3.11 | 3.12 PyPI - Version
license: MPL-2.0 readthedocs
CI status (linux) CI status (windows) CI status (mac)

themachinethatgoesping

Hi there 👋 themachinethatgosping (short: Ping) aims at enabling advanced processing of multibeam and singlebeam echosounder data. Core components of this library are implemented in C++ (for performance) and are then exposed as high level python interfaces (for usability). On top of the core, many libraries, tools and applications will be implemented in Python directly, making use of the fast prototyping features of this language.

This project is in early stage; at the moment it is just a powerfull raw data reader for Kongsberg .all/.wcd and Simard .raw data. However you can get glimples of what ping will be like and e.g. plot some simple echograms or extract the navigation data from the raw files (see tutorials repository)

More will follow soon. If you are interested in our plans and time line, contact me: peter.urban@ugent.be

installation

Ping is distributed via pypi. Install e.g. via pip:

pip install themachinethatgoesping

For more details or installing from source see the main repository: themachinethatgoesping

tutorials

We provide jupyter notebook tutorials with instalation instructions in the tutorials repository: tutorials

status

ci-readthedocs
ci-python-linux
ci-python-windows
ci-python-mac

relevant repositories

Ping consists of a number of repositories that represent individual modules. It is not necessary to check all of these repositories individually. The themachinethatgoesping repository includes all module repositories as subprojects. If you just want to test ping, the tutorials repository includes everything that is necessary.

  • tutorials tutorials: Tutorial and example notebooks
  • themachinethatgoesping-linux themachinethatgoesping-windows themachinethatgoesping-mac themachinethatgoesping: superproject that builds and installs all subprojects
  • tools-linux tools-windows tools-mac tools: Shared functions and interfaces
  • algorithms-linux algorithms-windows algorithms-mac algorithms: Algorithms for e.g. applying absorption, raytracing, bottom detection on echograms ...
  • navigation-linux navigation-windows navigation-mac navigation: Store and transform navigation data
  • echosoudners-linux echosoudners-windows echosoudners-mac echosounders: Read, write and process single- and multibeam echo sounder files.
  • pingprocessing-linux pingprocessing-windows pingprocessing-mac pingprocessing: Process pings (e.g. to echograms).
  • gridding-linux gridding-windows gridding-mac gridding: Gridding functions (python only test repo)

license

Most of ping is distributed under the Mozilla Public License Version 2.0 (MPL-2.0)

In simple terms: The MPL-2.0 license implements a non-viral copyleft; Licensed files are protected by the copyleft, but they can still be deeply integrated even in comercial, closed source projects, as long as the file itself stays open source.

Note that this simplified description is not a legal advice and does not cover all aspects of the license. For this please refer to the license self: https://www.mozilla.org/en-US/MPL/2.0/FAQ/

For other sources that may be easyer to comprehend see also

Contributing / Further development / Use

This project is still in early stage (bootstrapping). Documentation is mediocore at best. If you are interested in testing/using/contributing to this project, please contact me: peter.urban@ugent.be

Acknowledgements / Funding

  • The code of this project is partly based on code that was written while working for the DeepSea Monitoring Group DeepSea Monitoring Group - GEOMAR at GEOMAR, Helmholtz Centre for Ocean Research, Kiel, Germany. GEOMAR Helholtz-Centre for ocean research Kiel
  • Current development is happening at Ghent University, Ghent, Belgium Ghent University within the TURBEAMS project that is financed by the Belgian Science Policy Office (belspo) belspo

Pinned

  1. themachinethatgoesping themachinethatgoesping Public

    Super-project for themachinethatgoesping components

    Python 8

  2. tutorials tutorials Public

    Tutorial notebooks for publishing with MyBinder

    Jupyter Notebook 1

  3. multibeam-echo-grid-simulator multibeam-echo-grid-simulator Public

    This repository contains the python simulation code (https://doi.org/10.3289/SW_3_2023) for reproducing the results of the paper "Echo grid integration: A novel method for preprocessing multibeam w…

    Python 3 1

Repositories

Showing 10 of 13 repositories
  • tools Public

    Shared functions (C++) and small tools (python)

    C++ 0 MPL-2.0 0 0 0 Updated May 31, 2024
  • navigation Public

    Tools for interpolating and transforming navigation data

    C++ 0 MPL-2.0 0 0 0 Updated May 31, 2024
  • themachinethatgoesping Public

    Super-project for themachinethatgoesping components

    Python 8 MPL-2.0 0 5 (2 issues need help) 0 Updated May 30, 2024
  • algorithms Public

    Algorithms for processing ping data (a.g. apply absorption, raytrace beams or images, bottom detection in echograms ...)

    C++ 0 MPL-2.0 0 0 0 Updated May 30, 2024
  • echosounders Public

    This repository contains libraries to read, write and process single- and multibeam echo sounder file formats.

    C++ 0 MPL-2.0 0 0 0 Updated May 30, 2024
  • gridding Public

    python only test module / implements some echo gridding functions

    Python 0 MPL-2.0 0 0 0 Updated May 30, 2024
  • pingprocessing Public

    A themachinethatgoesping library to process pings: (e.g. build echograms)

    Python 0 MPL-2.0 0 0 0 Updated May 30, 2024
  • tutorials Public

    Tutorial notebooks for publishing with MyBinder

    Jupyter Notebook 1 CC0-1.0 0 0 0 Updated May 24, 2024
  • .github Public

    themachinethatgoesping project

    0 MPL-2.0 0 0 0 Updated Apr 16, 2024
  • meta Public

    This respository contains meta information (__init__.py files) for themachinethatgoesping packages

    Python 0 MPL-2.0 0 0 0 Updated Feb 15, 2024

Top languages

Loading…

Most used topics

Loading…