Skip to content

SASlabgroup/microSWIFTtelemetry

Repository files navigation

PyPI Python Package using Conda GitHub license

microSWIFTtelemetry

Provides Python-based functionality for pulling telemetry from the microSWIFT wave buoy developed at the University of Washington Applied Physics Laboratory (UW-APL).

Contents

This package contains python functions for programmatically accessing and compiling microSWIFT data from the UW-APL SWIFT server at http://swiftserver.apl.washington.edu/ (base URL). The primary functions are contained in the pull_telemetry.py module and include:

  • pull_telemetry_as_var() — return request as a variable in memory
  • pull_telemetry_as_zip() — return request as a .zip file
  • pull_telemetry_as_json() — return request as JSON-formatted text
  • pull_telemetry_as_kml() — return a .kml file of GPS positions

See examples/ for usage.


NOTE:

Please note this package is only developed to work with microSWIFTs and not the larger SWIFT buoys. For a MALTAB-based implementation that works for the entire suite of SWIFTs, see SWIFT-codes and the pullSWIFTtelemetry.m function at https://github.com/SASlabgroup/SWIFT-codes/blob/master/GeneralTools/pullSWIFTtelemetry.m.

The server can also be queryed and explored using the web page and web-based map:


Installation

The latest release of microSWIFTtelemetry can be installed from PyPI using pip:

pip install microSWIFTtelemetry

Organization

microSWIFTtelemetry/
├── LICENSE
├── README.md
├── docs
├── examples/
│   ├── create_telemetry_report_example.ipynb
│   └── pull_telemetry_example.ipynb
├── microSWIFTtelemetry/
│   ├── __init__.py
│   ├── pull_telemetry.py
│   ├── sbd/
│   │   ├── __init__.py
│   │   ├── compile_sbd.py
│   │   ├── definitions.py
│   │   └── read_sbd.py
│   └── version.py
├── pyproject.toml
├── requirements.txt
├── setup.py
└── tests/
    └── test_microSWIFTtelemetry.py

microSWIFT

Learn more about the microSWIFT wave buoy:

Schematic depicting buoys telemetering wave data from the ocean to a scientist on land via satellite: schematic depicting buoys telemetering wave data from the ocean to a scientist on land via satellite

About

microSWIFTtelemetry provides Python-based functionality for pulling telemetry from the microSWIFT wave buoy.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages