Skip to main content

Parser for Sea-Bird's CTD and TSG.

Project description

https://zenodo.org/badge/4645/castelao/seabird.svg https://readthedocs.org/projects/seabird/badge/?version=latest https://img.shields.io/travis/castelao/seabird.svg https://codecov.io/github/castelao/seabird/coverage.svg?branch=master https://img.shields.io/pypi/v/seabird.svg

This is a parser for Sea Bird CTD and TSG output files.

The Sea Bird CTD post processed data usually uses the .cnv extention. The purpose of the PySeabird is to parse this type of files, considering the different versions along the time, as well as different setups.

At this point my goal is to have an object with the attributes parsed from the header, and the data as Masked Arrays, so that the user doesn’t need to loose time evaluating the version and details of that cnv, but have it in a standard pattern, ready to use.

ATENTION, this is not an official package, so if you have trouble with it, do not complain to Sea-Bird. Open an issue at GitHub (https://github.com/castelao/seabird/issues), and I’ll try to help you.

Support and Documentation

The documentation is available at seabird.readthedocs.org.

The Seasoft manual might be the best reference for the format used.

If PySeabird doesn’t work with your .cnv files, send me a sample (just one .cnv) and I’ll fix to run it. The SeaBird changed the format several times along the time, so I need to see what do you have, to adjust PySeabird to work with it.

Quick howto use

To install:

pip install seabird

One way to use is running on the shell the cnvdump. Independent of the historical version of the cnv file, it will return a default structure:

seabird cnvdump your_file.cnv

To convert a .cnv (CTD output) into a NetCDF file, run:

seabird cnv2nc your_file.cnv

In a python script, one can use like this:

from seabird.cnv import fCNV

profile = fCNV(‘your_file.cnv’)

profile.attributes # It will return the header, as a dictionary.

profile.keys() # It will list the available variables.

profile[‘TEMP2’] # If TEMP2 was on the .keys(), this is how you get the data. It will be a masked array.

Check the example notebooks: http://nbviewer.ipython.org/github/castelao/seabird/tree/master/docs/notebooks/

License

seabird is licensed under a 3-clause BSD style license - see LICENSE.rst

Authors

Guilherme Castelão <guilherme@castelao.net> and Luiz Irber <luiz.irber@gmail.com>

History

0.9.x

  • This release is a dirty solution for some issues that I would like to address before refactor the whole package.

  • Reads CTD bottle files (.btl)

0.8.x

  • Removed dependency on YAML, in favor to JSON.

  • Added support to read binary file type.

0.7.x

  • Python 2.6 is no long supported.

0.6.x

  • CF vocabulary for variables names (PRES, TEMP, PSAL, LONGITUDE …)

  • Reorganizing the package. Removed src, and added several supporting files.

  • Moving CNVError into seabird.exceptions

  • Updated status for Production.

  • Bugfix to md5hash a file with special latin1 characters.

0.5.9

  • New attributes, sbe_model and instrument_type.

  • Sorry, lost track of updates.

0.5.3

  • Found a bug on load_data. Zeros could be mistaken by a bad_flag lower than 1e-8.

  • The new rule accepts no notes on the header.

  • Thanks to Laurynas for the .cnv file example that trigged the items above.

0.5.1

  • Testing structure

  • Some minor improvements in the core.

0.4.4

  • Carolina Nobre provided some .cnv files without any time variable, i.e. no timeS, timeJ or timeQ. The CNV() will not fail anymore if lacks a time record.

0.4

  • The oficial package name now is seabird. I realized that my goal here goes beyond to just parse the .cnv files, so the name seabird covers it better.

0.3

  • cnv2nc, a script to convert the cnv into a netCDF file.

0.2

  • First public release

0.1.8

  • Refactoring. Parsed text is saved in self.parsed, preparing to output

    everything that wasn’t specifically parsed.

  • XML is extracted into self.attributes[‘awkward_xml’]

0.1.7

  • Now it calculate and include the hex md5sum.

  • Bugfix, now handle well when timeJ has masked values.

  • Bugfix converting timeJ, it was one day longer.

  • I’ll run on the whole PIRATA dataset to check against different formats

    and after that it will be ready for 0.2 as Beta version

0.1.6

  • When position available in the header.intro as NMEA, load this instead of

    try to parse from the header.notes.

  • Load default values from a yaml file, like attributes{cruise, project,

    shipname …}

  • Using a recommended variable names list

0.1.5

  • Initial prototype of the cnvdump

0.1.1

  • Rules are now inside the package, and loaded with pkg_resources.

0.1

Release date: 3-Jul-2012

  • Initial import.

  • It’s able to load the variables into Masked Array, but it’s not the best way to do it.

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

seabird-0.10.3.tar.gz (29.8 kB view details)

Uploaded Source

Built Distribution

seabird-0.10.3-py2.py3-none-any.whl (25.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file seabird-0.10.3.tar.gz.

File metadata

  • Download URL: seabird-0.10.3.tar.gz
  • Upload date:
  • Size: 29.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for seabird-0.10.3.tar.gz
Algorithm Hash digest
SHA256 2e3499724f21c3c7897015afd25d4486bf6bc5a596cb21676ab06f4623876c3b
MD5 7b784925e2c6e46435f5fa1a68accd09
BLAKE2b-256 b9174a43866484dbbb3105684a7e41f4a654562ffde6f48c623cb9102fcb8f36

See more details on using hashes here.

File details

Details for the file seabird-0.10.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for seabird-0.10.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f7ffd6671d855446fb3a8422c99264b005c85c40515430fee1a8f16bbd9a1d67
MD5 ad96c0cfaeab90d8b8768d5c3a2ac28d
BLAKE2b-256 38695fca3cd9e05abc664b43fdf610b32bb73e063f96cb7aa1b0101e52260a17

See more details on using hashes here.

Supported by

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