=======
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 <guilherme@castelao.net> and Luiz Irber <luiz.irber@gmail.com>
Raw data
{
"_id": null,
"home_page": "",
"name": "seabird",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "oceanography,ocean data,CTD,TSG,SeaBird,hydrography,parser",
"author": "Guilherme Castelao , Luiz Irber",
"author_email": "guilherme@castelao.net, luiz.irber@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/09/9b/0d78dbb97ddf4aba17f6c0d729409e994ba3b6c28211107d48b3744b81c3/seabird-0.12.0.tar.gz",
"platform": "any",
"description": "=======\nSeabird\n=======\n\n.. image:: https://zenodo.org/badge/4645/castelao/seabird.svg\n :target: https://zenodo.org/badge/latestdoi/4645/castelao/seabird\n\n.. image:: https://readthedocs.org/projects/seabird/badge/?version=latest\n :target: https://readthedocs.org/projects/seabird/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/travis/castelao/seabird.svg\n :target: https://travis-ci.org/castelao/seabird\n\n.. image:: https://codecov.io/gh/castelao/seabird/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/castelao/seabird\n\n.. image:: https://img.shields.io/pypi/v/seabird.svg\n :target: https://pypi.python.org/pypi/seabird\n\n.. image:: https://mybinder.org/badge_logo.svg\n :target: https://mybinder.org/v2/gh/castelao/seabird/master?filepath=docs%2Fnotebooks\n\n\nThis is a parser for Sea Bird CTD and TSG output files.\n\nThe `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.\n\nAt 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.\n\nATENTION, 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.\n\n.. _`Sea Bird CTD`: http://www.seabird.com/software/SBEDataProcforWindows.htm\n\nSupport and Documentation\n-------------------------\n\nThe documentation is available at `seabird.readthedocs.org`_.\n\nThe `Seasoft`_ manual might be the best reference for the format used.\n\nIf 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.\n\n.. _`seabird.readthedocs.org`: http://seabird.readthedocs.org\n.. _`Seasoft`: http://www.seabird.com/pdf_documents/manuals/Seasoft_4.249Rev05-02.pdf\n\nQuick howto use\n---------------\n\nTo install:\n\n pip install seabird\n\n\nOne 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:\n\n seabird cnvdump your_file.cnv\n\n\nTo convert a .cnv (CTD output) into a NetCDF file, run:\n\n seabird cnv2nc your_file.cnv\n\n\nIn a python script, one can use like this:\n\n from seabird.cnv import fCNV\n\n profile = fCNV('your_file.cnv')\n\n profile.attrs # It will return the header, as a dictionary.\n\n profile.keys() # It will list the available variables.\n\n profile['TEMP2'] # If TEMP2 was on the .keys(), this is how you get the data. It will be a masked array.\n\n\nCheck the example notebooks: http://nbviewer.ipython.org/github/castelao/seabird/tree/master/docs/notebooks/\n\n\nLicense\n-------\n\n``seabird`` is licensed under a 3-clause BSD style license - see LICENSE.rst\n\nAuthors\n-------\n\nGuilherme Castel\u00e3o <guilherme@castelao.net> and Luiz Irber <luiz.irber@gmail.com>\n",
"bugtrack_url": null,
"license": "3-clause BSD",
"summary": "Parser for Sea-Bird's CTD and TSG",
"version": "0.12.0",
"split_keywords": [
"oceanography",
"ocean data",
"ctd",
"tsg",
"seabird",
"hydrography",
"parser"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c9c932a34c894ab90880a4d94fb542f20f9d536b7aa252edb2d1531dee4f0d5c",
"md5": "a0874830aca115ef491a9c2d763bd4f8",
"sha256": "a26934d2dcbbc32a81ac1f8f1a5922799bb7d6016c7031547bd14b24580cd812"
},
"downloads": -1,
"filename": "seabird-0.12.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0874830aca115ef491a9c2d763bd4f8",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 26943,
"upload_time": "2023-01-29T04:41:17",
"upload_time_iso_8601": "2023-01-29T04:41:17.620380Z",
"url": "https://files.pythonhosted.org/packages/c9/c9/32a34c894ab90880a4d94fb542f20f9d536b7aa252edb2d1531dee4f0d5c/seabird-0.12.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "099b0d78dbb97ddf4aba17f6c0d729409e994ba3b6c28211107d48b3744b81c3",
"md5": "f7805f0106bbcc31352d988294fd5e32",
"sha256": "f5902a3e795946f09e711a02e0b2dcc7efa782d5238cab5de2e2858d72af27aa"
},
"downloads": -1,
"filename": "seabird-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "f7805f0106bbcc31352d988294fd5e32",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 294626,
"upload_time": "2023-01-29T04:41:19",
"upload_time_iso_8601": "2023-01-29T04:41:19.680333Z",
"url": "https://files.pythonhosted.org/packages/09/9b/0d78dbb97ddf4aba17f6c0d729409e994ba3b6c28211107d48b3744b81c3/seabird-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-29 04:41:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "seabird"
}
JSON