BUFR Tools
==========
A suite of utilities and scripts to forge a BUFR file, or decode one.
Installation
------------
`bufrtools` is available in the `axiom-data-science` channel on anaconda.org.
```
conda install -c axiom-data-science bufrtools
```
Development
-----------
It is advisable to use conda for development and usage of this project, although it's not strictly
necessary. This README assumes the use of conda, however.
To install the environment:
```
conda env create -f environment.yml
```
Usage
=====
Encoding Wildlife Computers netCDF Profiles
-------------------------------------------
The `wildlife_computers` module provides a command-line interface for encoding a Wildlife Computers' netCDF profile dataset as a BUFR message.
Usage:
```
python bufrtools/encoding/wildlife_computers.py -o <output bufr file> <netCDF path>
```
The following table contains the expanded sequence of descriptors for temperature salinity profiles and trajectories originating from marine animal tags.
The source of this information is the published [Manual on WMO Codes](https://library.wmo.int/doc_num.php?explnum_id=10722).
| parent | fxy | text | Subtitle |
|--------|--------|---------------------------------------------------------------------------------|----------------------------------------------------|
| 315013 | 315013 | (Met-ocean observations from marine animal tags) (Sequence) | |
| 315013 | 301150 | WIGOS identifier (Sequence) | |
| 301150 | 001125 | WIGOS identifier series (Numeric) | |
| 301150 | 001126 | WIGOS issuer of identifier (Numeric) | |
| 301150 | 001127 | WIGOS issue number (Numeric) | |
| 301150 | 001128 | WIGOS local identifier (character) (CCITT IA5) | |
| 315013 | 001087 | WMO marine observing platform extended identifier (Numeric) | WMO number where assigned |
| 315013 | 208032 | Change width of CCITT IA5 field (Operator) | change width to 32 characters |
| 315013 | 001019 | Long station or site name (CCITT IA5) | Platform ID, e.g. ct145-933-BAT2-19 (max 32-chars) |
| 315013 | 208000 | Change width of CCITT IA5 field (Operator) | Cancel change width |
| 315013 | 003001 | Surface Station Type (Code table) | 10 (Marine Animal) |
| 315013 | 022067 | Instrument type for water temperature/salinity profile measurement (Code table) | Set to 995 (attached to marine animal) |
| 315013 | 001051 | Platform Transmitter ID number (CCITT IA5) | e.g. Argos PTT |
| 315013 | 002148 | Data collection and/or location system (Code table) | |
| 315013 | 112000 | Delayed replication of 12 descriptors (Replication) | |
| 315013 | 031001 | Delayed descriptor replication factor (Numeric) | |
| 315013 | 008021 | Time significance (Code table) | set to 26, time of last known position |
| 315013 | 301011 | (Year, month, day) (Sequence) | |
| 301011 | 004001 | Year (a) | |
| 301011 | 004002 | Month (mon) | |
| 301011 | 004003 | Day (d) | |
| 315013 | 301012 | (Hour, minute) (Sequence) | |
| 301012 | 004004 | Hour (h) | |
| 301012 | 004005 | Minute (min) | |
| 315013 | 301021 | (Latitude / longitude (high accurracy)) (Sequence) | |
| 301021 | 005001 | Latitude (high accuracy) (deg) | |
| 301021 | 006001 | Longitude (high accuracy) (deg) | |
| 315013 | 001012 | Direction of motion of moving observing platform (degree true) | |
| 315013 | 001014 | Platform drift speed (high precision) (m/s) | |
| 315013 | 033022 | Quality of buoy satellite transmission (Code table) | |
| 315013 | 033023 | Quality of buoy location (Code table) | |
| 315013 | 033027 | Location quality class (range of radius of 66% confidence) (Code table) | |
| 315013 | 007063 | Depth below sea/water surface (m) | |
| 315013 | 022045 | Sea / Water Temperature (K) | |
| 315013 | 008021 | Time significance (Code table) | Set to missing / cancel |
| 315013 | 107000 | Delayed replication of 7 descriptors (Replication) | |
| 315013 | 031001 | Delayed descriptor replication factor (Numeric) | |
| 315013 | 301011 | (Year, month, day) (Sequence) | |
| 301011 | 004001 | Year (a) | |
| 301011 | 004002 | Month (mon) | |
| 301011 | 004003 | Day (d) | |
| 315013 | 301012 | (Hour, minute) (Sequence) | |
| 301012 | 004004 | Hour (h) | |
| 301012 | 004005 | Minute (min) | |
| 315013 | 301021 | (Latitude / longitude (high accurracy)) (Sequence) | |
| 301021 | 005001 | Latitude (high accuracy) (deg) | |
| 301021 | 006001 | Longitude (high accuracy) (deg) | |
| 315013 | 001079 | Unique identifier for the profile (CCITT IA5) | Profile ID |
| 315013 | 001023 | Observation sequence number (Numeric) | Upcast number |
| 315013 | 022056 | Direction of profile (Code table) | Set to 0 (ascending / upwards) |
| 315013 | 306035 | Temperature and salinity profile (Sequence) | |
| 306035 | 112000 | Delayed replication of 12 descriptors (Replication) | |
| 306035 | 031002 | Extended delayed descriptor replication factor (Numeric) | |
| 306035 | 007062 | Depth below sea/water surface (m) | In metres |
| 306035 | 008080 | Qualifier for GTSPP quality flag (Code table) | = 13 Depth at a level |
| 306035 | 033050 | Global GTSPP quality flag (Code table) | |
| 306035 | 007065 | Water pressure (Pa) | |
| 306035 | 008080 | Qualifier for GTSPP quality flag (Code table) | = 10 Pressure at a level |
| 306035 | 033050 | Global GTSPP quality flag (Code table) | |
| 306035 | 022043 | Sea/water temperature (K) | |
| 306035 | 008080 | Qualifier for GTSPP quality flag (Code table) | = 11 Temperature at a level |
| 306035 | 033050 | Global GTSPP quality flag (Code table) | |
| 306035 | 022064 | Salinity (0/00) | = 12 Salinity at a level |
| 306035 | 008080 | Qualifier for GTSPP quality flag (Code table) | |
| 306035 | 033050 | Global GTSPP quality flag (Code table) | |
Raw data
{
"_id": null,
"home_page": "https://github.com/axiom-data-science/bufrtools",
"name": "bufrtools",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Luke Campbell",
"author_email": "luke@axds.co",
"download_url": "https://files.pythonhosted.org/packages/b9/76/0a8261b9052b2e7562ec8fd05f8dd5c7d642b921592d4dfab9089269a677/bufrtools-1.1.4.tar.gz",
"platform": null,
"description": "BUFR Tools\n==========\n\nA suite of utilities and scripts to forge a BUFR file, or decode one.\n\n\nInstallation\n------------\n\n`bufrtools` is available in the `axiom-data-science` channel on anaconda.org.\n\n```\nconda install -c axiom-data-science bufrtools\n```\n\nDevelopment\n-----------\n\nIt is advisable to use conda for development and usage of this project, although it's not strictly\nnecessary. This README assumes the use of conda, however.\n\n\nTo install the environment:\n\n```\nconda env create -f environment.yml\n```\n\n\nUsage\n=====\n\nEncoding Wildlife Computers netCDF Profiles\n-------------------------------------------\n\nThe `wildlife_computers` module provides a command-line interface for encoding a Wildlife Computers' netCDF profile dataset as a BUFR message.\n\nUsage:\n```\npython bufrtools/encoding/wildlife_computers.py -o <output bufr file> <netCDF path>\n```\n\nThe following table contains the expanded sequence of descriptors for temperature salinity profiles and trajectories originating from marine animal tags.\n\nThe source of this information is the published [Manual on WMO Codes](https://library.wmo.int/doc_num.php?explnum_id=10722).\n\n| parent | fxy | text | Subtitle |\n|--------|--------|---------------------------------------------------------------------------------|----------------------------------------------------|\n| 315013 | 315013 | (Met-ocean observations from marine animal tags) (Sequence) | |\n| 315013 | 301150 | WIGOS identifier (Sequence) | |\n| 301150 | 001125 | WIGOS identifier series (Numeric) | |\n| 301150 | 001126 | WIGOS issuer of identifier (Numeric) | |\n| 301150 | 001127 | WIGOS issue number (Numeric) | |\n| 301150 | 001128 | WIGOS local identifier (character) (CCITT IA5) | |\n| 315013 | 001087 | WMO marine observing platform extended identifier (Numeric) | WMO number where assigned |\n| 315013 | 208032 | Change width of CCITT IA5 field (Operator) | change width to 32 characters |\n| 315013 | 001019 | Long station or site name (CCITT IA5) | Platform ID, e.g. ct145-933-BAT2-19 (max 32-chars) |\n| 315013 | 208000 | Change width of CCITT IA5 field (Operator) | Cancel change width |\n| 315013 | 003001 | Surface Station Type (Code table) | 10 (Marine Animal) |\n| 315013 | 022067 | Instrument type for water temperature/salinity profile measurement (Code table) | Set to 995 (attached to marine animal) |\n| 315013 | 001051 | Platform Transmitter ID number (CCITT IA5) | e.g. Argos PTT |\n| 315013 | 002148 | Data collection and/or location system (Code table) | |\n| 315013 | 112000 | Delayed replication of 12 descriptors (Replication) | |\n| 315013 | 031001 | Delayed descriptor replication factor (Numeric) | |\n| 315013 | 008021 | Time significance (Code table) | set to 26, time of last known position |\n| 315013 | 301011 | (Year, month, day) (Sequence) | |\n| 301011 | 004001 | Year (a) | |\n| 301011 | 004002 | Month (mon) | |\n| 301011 | 004003 | Day (d) | |\n| 315013 | 301012 | (Hour, minute) (Sequence) | |\n| 301012 | 004004 | Hour (h) | |\n| 301012 | 004005 | Minute (min) | |\n| 315013 | 301021 | (Latitude / longitude (high accurracy)) (Sequence) | |\n| 301021 | 005001 | Latitude (high accuracy) (deg) | |\n| 301021 | 006001 | Longitude (high accuracy) (deg) | |\n| 315013 | 001012 | Direction of motion of moving observing platform (degree true) | |\n| 315013 | 001014 | Platform drift speed (high precision) (m/s) | |\n| 315013 | 033022 | Quality of buoy satellite transmission (Code table) | |\n| 315013 | 033023 | Quality of buoy location (Code table) | |\n| 315013 | 033027 | Location quality class (range of radius of 66% confidence) (Code table) | |\n| 315013 | 007063 | Depth below sea/water surface (m) | |\n| 315013 | 022045 | Sea / Water Temperature (K) | |\n| 315013 | 008021 | Time significance (Code table) | Set to missing / cancel |\n| 315013 | 107000 | Delayed replication of 7 descriptors (Replication) | |\n| 315013 | 031001 | Delayed descriptor replication factor (Numeric) | |\n| 315013 | 301011 | (Year, month, day) (Sequence) | |\n| 301011 | 004001 | Year (a) | |\n| 301011 | 004002 | Month (mon) | |\n| 301011 | 004003 | Day (d) | |\n| 315013 | 301012 | (Hour, minute) (Sequence) | |\n| 301012 | 004004 | Hour (h) | |\n| 301012 | 004005 | Minute (min) | |\n| 315013 | 301021 | (Latitude / longitude (high accurracy)) (Sequence) | |\n| 301021 | 005001 | Latitude (high accuracy) (deg) | |\n| 301021 | 006001 | Longitude (high accuracy) (deg) | |\n| 315013 | 001079 | Unique identifier for the profile (CCITT IA5) | Profile ID |\n| 315013 | 001023 | Observation sequence number (Numeric) | Upcast number |\n| 315013 | 022056 | Direction of profile (Code table) | Set to 0 (ascending / upwards) |\n| 315013 | 306035 | Temperature and salinity profile (Sequence) | |\n| 306035 | 112000 | Delayed replication of 12 descriptors (Replication) | |\n| 306035 | 031002 | Extended delayed descriptor replication factor (Numeric) | |\n| 306035 | 007062 | Depth below sea/water surface (m) | In metres |\n| 306035 | 008080 | Qualifier for GTSPP quality flag (Code table) | = 13 Depth at a level |\n| 306035 | 033050 | Global GTSPP quality flag (Code table) | |\n| 306035 | 007065 | Water pressure (Pa) | |\n| 306035 | 008080 | Qualifier for GTSPP quality flag (Code table) | = 10 Pressure at a level |\n| 306035 | 033050 | Global GTSPP quality flag (Code table) | |\n| 306035 | 022043 | Sea/water temperature (K) | |\n| 306035 | 008080 | Qualifier for GTSPP quality flag (Code table) | = 11 Temperature at a level |\n| 306035 | 033050 | Global GTSPP quality flag (Code table) | |\n| 306035 | 022064 | Salinity (0/00) | = 12 Salinity at a level |\n| 306035 | 008080 | Qualifier for GTSPP quality flag (Code table) | |\n| 306035 | 033050 | Global GTSPP quality flag (Code table) | |\n",
"bugtrack_url": null,
"license": "",
"summary": "A suite of tools for working with BUFR",
"version": "1.1.4",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b95ff5ed29c01311b35bbeef02871ee43f2f8c2acc4539701ed16a61a6aed152",
"md5": "6cfae8898e59696adc3275a69d2fcbad",
"sha256": "f3ce95e28df2d21f577042eefaba5df5d34bda51204793ed3e7db8008445c74c"
},
"downloads": -1,
"filename": "bufrtools-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6cfae8898e59696adc3275a69d2fcbad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 296040,
"upload_time": "2023-01-11T20:06:37",
"upload_time_iso_8601": "2023-01-11T20:06:37.507962Z",
"url": "https://files.pythonhosted.org/packages/b9/5f/f5ed29c01311b35bbeef02871ee43f2f8c2acc4539701ed16a61a6aed152/bufrtools-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b9760a8261b9052b2e7562ec8fd05f8dd5c7d642b921592d4dfab9089269a677",
"md5": "d3b778f2f6b6465a630ffd2364de3e92",
"sha256": "9693c9c017554269679d6a6e3022ed3a82b1e347e1eaf3a1872570c299ad7ca5"
},
"downloads": -1,
"filename": "bufrtools-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "d3b778f2f6b6465a630ffd2364de3e92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 256351,
"upload_time": "2023-01-11T20:06:39",
"upload_time_iso_8601": "2023-01-11T20:06:39.413231Z",
"url": "https://files.pythonhosted.org/packages/b9/76/0a8261b9052b2e7562ec8fd05f8dd5c7d642b921592d4dfab9089269a677/bufrtools-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-11 20:06:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "axiom-data-science",
"github_project": "bufrtools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "cftime",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "pocean-core",
"specs": [
[
">=",
"1.9.3"
]
]
},
{
"name": "pyarrow",
"specs": []
},
{
"name": "pyyaml",
"specs": []
}
],
"lcname": "bufrtools"
}
JSON
