npolar / argos-ruby

Argos satellite tracking data tools

argos-ruby

argos-ruby contains tools for working with Argos satellite tracking data and services:

• Parsers for Argos ASCII files (DS/DAT and DIAG/DIA files)
• SOAP web service client
• Web service download tool
• Sensor data decoders

argos-ruby is developed by staff at the Norwegian Polar Data Centre.

The library is fully unit tested and used in production in various Tracking APIsthe Tracking APIs.

Argos ASCII to JSON

The command-line tool argos-ascii converts DS or DIAG files to JSON using the ruby classes Argos::Ds and Argos::Diag. The data conversion in mostly Regexp-based so could easily be ported to other programming languages.

Examples

$ argos-ascii spec/argos/_ds/*.DAT
$ argos-ascii --action=source "spec/argos/_d*"
$ argos-ascii --filter='lambda {|d| d[:program] == 9660 and d[:platform] == 2189 }' spec/argos/_ds/990660_A.DAT

The source action provides a metadata summary, list of programs, platforms, etc.

See argos-ascii or run argos-ascii for documentation.

SOAP webservice client

The command-line tool argos-soap provides access to all operations (as of v1.4) in the Argos SOAP webservice.

See argos-soap or run argos-soapfor command-help.

Examples

$ argos-soap -o getXsd # does not require authentication
$ argos-soap -o getXml --username=USERNAME --password=PASSWORD
$ argos-soap -o getPlatformList --username=USERNAME --password=PASSWORD

Download tool

The argos-soap command also contains a convient download tool, that runs the getXml operation for each platform for each of the last 20 days. The download tool creates one XML data file per platform per day, stored in a file structure like

• /path/to/tracking/archive/argos/xml/$year/program-$program/platform-$platform/argos-$year-$mm-$dd-platform-$platform.xml
• /path/to/tracking/archive/argos/xml/2015/program-9660/platform-2180/argos-2015-03-06-platform-2180.xml

$ argos-soap --download /path/to/tracking/archive/argos/xml --username=USERNAME --password=PASSWORD --debug

Argos XML to JSON

$ ./bin/argos-json-xslt /path/to/argos-data.xml
$ xsltproc lib/argos/_xslt/argos-json.xslt spec/argos/_soap/getXml.xml

Sensor data decoding

• [NorthStar4BytesDecoder]
• KiwiSat303Decoder
• KiwiSat202Decoder

Install

$ gem install argos-ruby
$ cd `gem environment gemdir`/gems/argos-ruby-1.6.0
$ bundle install

Note: The extra step is a bug

Links

• Argos User's Manual
• Argos Web Service Interface Specification v1.7 [issued 2015-09-25]
• http://alaska.usgs.gov/science/biology/spatial/
• http://gis-lab.info/programs/argos/argos-manual-eng.html
• CLS - operates the Argos system

argos-ruby's Issues

Add provider = cls.fr to all messages

Missing latitude2 breaks JSON

About to POST /mnt/datasets/Tracking/ARGOS/ws-argos.cls.fr/2014/program-11660/platform-113907/argos-2014-12-02-platform-113907.xml to https://api.npolar.no/tracking

parse error: unallowed token at this point in JSON text
          lc_index": 0,   "latitude2": ,   "longitude2": ,   "altitude
                     (right here) ------^
/home/external/.rvm/gems/ruby-2.1.3/gems/yajl-ruby-1.2.1/lib/yajl/json_gem/parsing.rb:15:in `rescue in parse'

Missing platform metadata (lastCollectDate) crashes downloader

F, [2014-11-26T09:46:23.474909 #7685] FATAL -- : {"platformId":"145019"}
no implicit conversion of nil into String/home/external/.rvm/gems/ruby-2.1.3/gems/argos-ruby-1.2.3/lib/argos/download.rb:46:in `parse'

argos-soap download duplicates data on year rollover...

Going back 20 days in January, means getting data from December last year that was already downloaded in the year-1 folder...

NorthStar4Bytes decoder: use battery_voltage

gem install argos-ruby fails to install dependencies from Gemfile