Skip to main content

processing of ship campaign data

Project description

shipspy: ship campaign data processing and standardisation

With shipspy, data from ship campaigns can be processed and standardised. A number of instruments are included.

Setup

Install shipspy (coming soon):

pip install shipspy

Using shipspy

The following processing options are available.

DShip

With the dship subcommand, data from the ship integrated system can be processed. For an exemplary order to download underway data, see [1]. The following steps are done:

  • Fixing time stamps
  • Averaging to minutely time stamps
  • Removing unphysical values
  • Renaming variables, changing units, and adding attributes
  • Converting to netCDF

To process dship data run

shipspy dship -i <input file> -o <output file> -a <attribute dictionary> -s <ship>

with

  • input file: downloaded data from BSH or GEOMAR (or directly from the ship) as txt or dat file with unix time stamp (seconds since 1970-01-01)
  • output file: file name of netCDF output file
  • attribute dictionary: yaml dictionary with variable names and attribute. For example dictionaries for the different research vessels see rv_information
  • ship: name of the ship. Options are Merian, Sonne, and Meteor

Renaming

The rename command can be used to

  • fix the time stamps
  • rename variables and add attributes
  • convert units to SI
  • remove unphysical values
  • Convert and save the file as netCDF

To rename a data file run

shipspy rename -i <input file> -o <output file> -a <attribute dictionary> -d <instrument>

with

  • input file: input file, file format depends on the instrument
  • output file: file name of netCDF output file
  • attribute dictionary: yaml dictionary with variable names and attribute. For examples see [1]
  • instrument: instrument name. Options are calitoo, ceilometer, ctd, hatpro, microtops, radiosondes, test, uav

Sections

The section command adds a new coordinate and specifies the time period of the campaign. To use it run

shipspy section -i <input file> -o <output file> -s <section file> -t <time dimension name> -a <global attribute dictionary>

with

  • input file: input netCDF file
  • output file: file name of netCDF output file
  • section file: txt file specifying the campaign dates (start, end, break) and the sections in which it should be divided. For an example, see [1].
  • time dimension name: name of the time dimension. Default is time but sometimes it can be something like start_time.
  • global attribute dictionary: yaml file with global attributes if wanted. For example files see [1].

The repository [1] with the settings for the ARC and additional scripts can serve as a template.

References

[1] Köhler, L. (2023). ARC: Processing of atmospheric and oceanographic measurements (Version v1.0.0) [Computer software]. https://github.com/LauraKoehler/arc_processing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shipspy-0.0.1.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shipspy-0.0.1-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file shipspy-0.0.1.tar.gz.

File metadata

  • Download URL: shipspy-0.0.1.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for shipspy-0.0.1.tar.gz
Algorithm Hash digest
SHA256 4c7d41c7550691ebcc92ae46f5353cbcf149e30aaf36b4c70949277185eb3db6
MD5 c53b1b1918420dee443c5e8e5bf4939c
BLAKE2b-256 613c621759e4225f010f00c042ce02ba67e889738f05c9472ddf942fdb882954

See more details on using hashes here.

File details

Details for the file shipspy-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: shipspy-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for shipspy-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7828d920ecf890f3cde4506e4747359d6f5b92dcfc2ece362884ca30e39b0e07
MD5 50792cb5b7db9e238b508d36ce69212e
BLAKE2b-256 1cd4a0a474e428341a3ac6b5d620ef6ddfcf05ea67ecdd1292298e995a8f9ee8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page