Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/castelao/seabird

Python parser for Sea-Bird CTD outputs, usually .cnv files.

https://github.com/castelao/seabird

Science Score: 20.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    1 of 10 committers (10.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.2%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Python parser for Sea-Bird CTD outputs, usually .cnv files.

Basic Info
  • Host: GitHub
  • Owner: castelao
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Size: 731 KB
Statistics
  • Stars: 52
  • Watchers: 7
  • Forks: 32
  • Open Issues: 32
  • Releases: 5
Created almost 14 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Changelog Contributing License

README.rst 

=======
Seabird
=======

.. image:: https://zenodo.org/badge/4645/castelao/seabird.svg
   :target: https://zenodo.org/badge/latestdoi/4645/castelao/seabird

.. image:: https://readthedocs.org/projects/seabird/badge/?version=latest
   :target: https://readthedocs.org/projects/seabird/?badge=latest
      :alt: Documentation Status

.. image:: https://img.shields.io/travis/castelao/seabird.svg
   :target: https://travis-ci.org/castelao/seabird

.. image:: https://codecov.io/gh/castelao/seabird/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/castelao/seabird

.. image:: https://img.shields.io/pypi/v/seabird.svg
   :target: https://pypi.python.org/pypi/seabird

.. image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/castelao/seabird/master?filepath=docs%2Fnotebooks


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.

.. _`Sea Bird CTD`: http://www.seabird.com/software/SBEDataProcforWindows.htm

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.

.. _`seabird.readthedocs.org`: http://seabird.readthedocs.org
.. _`Seasoft`: http://www.seabird.com/pdf_documents/manuals/Seasoft_4.249Rev05-02.pdf

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.attrs # 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  and Luiz Irber

Owner

  • Name: Guilherme Castelão
  • Login: castelao
  • Kind: user
  • Location: CO
  • Company: @NREL

multi-class: PhD in Physical Oceanography, offshore solo sailor, Rustacean and Pythonista.

GitHub Events

Total
  • Watch event: 3
  • Issue comment event: 2
  • Fork event: 2
Last Year
  • Watch event: 3
  • Issue comment event: 2
  • Fork event: 2

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 440
  • Total Committers: 10
  • Avg Commits per committer: 44.0
  • Development Distribution Score (DDS): 0.036
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Guilherme Castelao g****e@c****t 424
Luiz Irber l****r@g****m 6
poplarShift d****r@p****e 3
David Goldsmith e****n@g****m 1
Paul Focke p****e@v****e 1
Peter Shanks p****s@m****m 1
Callum Rollo c****o@o****m 1
Jessy Barrette 3****e 1
Nick 1****2 1
shaunbell s****l@n****v 1
Committer Domains (Top 20 + Academic)
noaa.gov: 1 megalong.com: 1 vliz.be: 1 posteo.de: 1 castelao.net: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 62
  • Total pull requests: 16
  • Average time to close issues: 4 months
  • Average time to close pull requests: 8 months
  • Total issue authors: 26
  • Total pull request authors: 11
  • Average comments per issue: 1.47
  • Average comments per pull request: 2.31
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 2.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • castelao (28)
  • OlyDLG (4)
  • aer205 (3)
  • dnowacki-usgs (2)
  • MathewBiddle (2)
  • guillotp (2)
  • mathiku (2)
  • fpahernandez (1)
  • debboutr (1)
  • tvsubhaskar (1)
  • moghimis (1)
  • callumrollo (1)
  • patrickcgray (1)
  • ghost (1)
  • Raniita (1)
Pull Request Authors
  • castelao (3)
  • JessyBarrette (2)
  • VeckoTheGecko (2)
  • luizirber (2)
  • poplarShift (1)
  • callumrollo (1)
  • paulfvliz (1)
  • botheredbybees (1)
  • OlyDLG (1)
  • nicholas512 (1)
  • shaunwbell (1)
Top Labels
Issue Labels
enhancement (19) bug (11)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 199 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 5
    (may contain duplicates)
  • Total versions: 29
  • Total maintainers: 1
pypi.org: seabird

Parser for Sea-Bird's CTD and TSG

  • Versions: 28
  • Dependent Packages: 1
  • Dependent Repositories: 5
  • Downloads: 199 Last month
Rankings
Dependent packages count: 4.7%
Dependent repos count: 6.7%
Average: 8.1%
Downloads: 13.0%
Maintainers (1)
castelao
Last synced: 11 months ago
conda-forge.org: seabird
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Forks count: 28.5%
Dependent repos count: 34.0%
Average: 38.0%
Stargazers count: 38.2%
Dependent packages count: 51.2%
Last synced: 11 months ago

Dependencies

requirements.txt pypi
  • Click >=6.6
  • numpy >=1.14
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
  • Click >=6.6
  • numpy >=1.14
binder/environment.yml pypi
  • cotede >=0.20.3