| Name | s100py JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | |
| Summary | This python package provides api and utilities for encoding hydrographic datasets in the International Hydrographic Organization (IHO) S-100 format |
| upload_time | 2023-12-15 21:12:15 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
s-100
s-102
s-111
s-104
hydrographic
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
s100py
======
[](https://github.com/noaa-ocs-s100/s100py/actions/workflows/s100py-tests.yml)
API and Utilities for Working with IHO S-100 HDF5 Data Formats
Overview
--------
This python package includes an API and utilities for encoding hydrographic
datasets in the International Hydrographic Organization (IHO) S-100
HDF5 format.
See [s100py Read the Docs](https://s100py.readthedocs.io/en/latest/) for more information.
Background
----------
The IHO S-100 standard is a data framework for digital products and
services for hydrographic, maritime, and GIS communities, comprised of
multiple data encoding formats designed for interoperability with
Electronic Navigational Charts (ENCs).
This package includes the following S-100 encoding formats:
- S-102 Bathymetric Surface
- S-104 Water Level Information for Surface Navigation
- S-111 Water Currents for Surface Navigation
However, support for additional formats as they become available will
be added in the future. For further information about S-100 formats,
see the [IHO website](http://s100.iho.int/S100/).
Create S100 Products
--------------------
- Follow [S-102](https://s100py.readthedocs.io/en/latest/s102.html#) examples to create an S-102 File
- Follow [S-104](https://s100py.readthedocs.io/en/latest/s104.html#) examples to create an S-104 File
- Follow [S-111](https://s100py.readthedocs.io/en/latest/s111.html#) examples to create an S-111 File
For S100 API Developers
-----------------------
- [Extending the API](https://s100py.readthedocs.io/en/latest/extending_the_api.html)
- [Example API](https://s100py.readthedocs.io/en/latest/sample_api.html)
- [Using Example API](https://s100py.readthedocs.io/en/latest/using_sample_api.html)
- [Advanced Example API Usage](https://s100py.readthedocs.io/en/latest/more_sample_api.html)
Requirements
------------
This codebase is written for Python >=3.8 and relies on the following python
packages:
- h5py
- numpy
- gdal
Installation
------------
Conda
-----
Installing s100py from the conda-forge channel can be achieved by adding conda-forge to your channels with:
```bash
conda config --add channels conda-forge
conda config --set channel_priority strict
```
Once the conda-forge channel has been enabled, s100py can be installed with conda:
```bash
conda install s100py
```
or with mamba:
```bash
mamba install s100py
```
It is possible to list all the versions of s100py available on your platform with conda:
```bash
conda search s100py --channel conda-forge
```
or with mamba:
```bash
mamba search s100py --channel conda-forge
```
Alternatively, mamba repoquery may provide more information:
**Search all versions available on your platform:**
```bash
mamba repoquery search s100py --channel conda-forge
```
**List packages depending on `s100py`:**
```bash
mamba repoquery whoneeds s100py --channel conda-forge
```
**List dependencies of `s100py`:**
```bash
mamba repoquery depends s100py --channel conda-forge
```
PIP
---
If installing with PIP, this package requires GDAL Python bindings be present,
so it usually can't be installed just using `pip install gdal`, but for more information
visit https://pypi.org/project/GDAL/.
Once `gdal` has been installed, s100py can be installed using `pip`:
```bash
pip install s100py
```
Release Notes
-------------
**Version 1.0.0 (2023-10-27)**
- This is a major release, which includes several new APIs that encapsulate the latest S-100 standard (S-100 Edition 5.0.0)
and S-100 Product Specifications (S-102 Edition 2.2.0, S-111 Edition 1.2.0, S-104 Edition 1.1.0) and adds support for
multiple S-100 Editions and Product Specification versions
- Additional convenience utilities have been added to generate:
* S-102 Edition 2.1.0 & 2.2.0 datasets
* S-111 Edition 1.0.0 & 1.2.0 datasets
* S-104 Edition 1.0.0 & 1.1.0 datasets
* S-102 Data Coding Format 9 (Feature Oriented Regular Grid) datasets
* S-104 Data Coding Format 3 (Irregular Grid) datasets
* S-104 Data Coding Format 7 (TIN) datasets
- S-102 Edition 2.1.0 (S-100 Edition 4.0) significant changes include:
* The depth orientation has changed from positive up to positive down
- S-102 Edition 2.2.0 (S-100 Edition 5.0) significant changes include:
* General metadata _horizontalDatumReference_ and _horizontalDatumValue_ have been removed
* General metadata attributes _horizontalCRS_ and _typeOfHorizontalCRS_ were added
* Stricter datatypes have been set for all attributes
* Added the feature attribute table _QualityOfSurvey_ which provides the following additional survey metadata:
* The categorization of the assessment level of bathymetric data for an area
* If the least depth of detected features in an area was measured
* If significant features have or have not been detected in the course of a survey
* The size of detected bathymetric features in an area
* Percentage of depth that a feature of such size could be detected
* If full seafloor coverage has been achieved in the area by hydrographic surveys
* Flag for bathy coverage nodes populated by interpolation
* The best estimate of the fixed horizontal or vertical accuracy component for positions, depths, heights, vertical
distances, and vertical clearances
* The factor to be applied to the variable component of uncertainty equation to provide the best estimate of the
variable horizontal or vertically accuracy component for positions, depths, heights, vertical distances, and
vertical clearances
* The start date of the period of the hydrographic survey
* The end date of the period of the hydrographic survey
* The survey filename or ID
* The authority which as responsible for the hydrographic survey
* An estimate of the magnitude of the difference between true and estimated bathymetric depth, after all appropriate
corrections are made
- S-111 Edition 1.2.0 (S-100 Edition 5.0.0) significant changes include:
* General metadata _horizontalDatumReference_ and _horizontalDatumValue_ have been removed
* General metadata attributes _horizontalCRS_ and _typeOfHorizontalCRS_ were added
* Stricter datatypes have been set for all attributes
* General metadata attribute _depthTypeIndex_ has been modified to only allow _heightOrDepth_ or _layerAverage_
* General metadata _datasetDeliveryInterval_ was added, describing the expected time interval between availability of
successive datasets for time-varying data, formatted as an ISO 8601 duration (e.g. 'PnYnMnDTnHnMnS')
* The enumeration attribute for the classification of data according the relationship between the time of its collection,
generation or calculation of generation parameters, in relation the time of publication has been changed from
_typeOfCurrentData_ to _dataDynamicity_
- S-104 Edition 1.1.0 (S-100 Edition 5.0.0) significant changes include:
* General metadata _horizontalDatumReference_ and _horizontalDatumValue_ have been removed
* General metadata attributes _horizontalCRS_ and _typeOfHorizontalCRS_ were added
* Stricter datatypes have been set for all attributes
* General metadata _datasetDeliveryInterval_ was added, describing the expected time interval between availability of
successive datasets for time-varying data, formatted as an ISO 8601 duration (e.g. 'PnYnMnDTnHnMnS')
* The enumeration attribute for the classification of data according the relationship between the time of its collection,
generation or calculation of generation parameters, in relation the time of publication has been changed from
_typeOfWaterLevelData_ to _dataDynamicity_
* General metadata _trendInterval_ was added, describing the interval in minutes over which trend at a particular time
is calculated
**Version 1.0.0-rc.1 (2021-02-11)**
- This is a major release, which includes a new API that encapsulates the data specifications to allow
introspection with Python to determine what data is available or should be and what data types would
be acceptable. Convenience utilities are available to convert data into S102/S104/S111 so detailed
knowledge of the S100 specs and APIs is not required in most cases
- Support for s102 (bathymetry) and s104 (water levels) has been added
- A consistent API for S100 data structures was added and is used to encode S102, S104, and S111
- The previous S111 library has been migrated to this general S100 API and therefore any
code written against the previous s100py library will no longer work
- Examples of using the new S111 API are available [here](https://s100py.readthedocs.io/en/latest/s111.html#example-usage)
Authors
-------
- Barry Gallagher (NOAA), <barry.gallagher@noaa.gov>
- Erin Nagel (UCAR), <erin.nagel@noaa.gov>
- Glen Rice (NOAA), <glen.rice@noaa.gov>
- Jason Greenlaw
License
-------
This work, as a whole, falls under Creative Commons Zero (see
[LICENSE](LICENSE)).
Disclaimer
----------
This repository is a scientific product and is not official
communication of the National Oceanic and Atmospheric Administration, or
the United States Department of Commerce. All NOAA GitHub project code
is provided on an 'as is' basis and the user assumes responsibility for
its use. Any claims against the Department of Commerce or Department of
Commerce bureaus stemming from the use of this GitHub project will be
governed by all applicable Federal law. Any reference to specific
commercial products, processes, or services by service mark, trademark,
manufacturer, or otherwise, does not constitute or imply their
endorsement, recommendation or favoring by the Department of Commerce.
The Department of Commerce seal and logo, or the seal and logo of a DOC
bureau, shall not be used in any manner to imply endorsement of any
commercial product or activity by DOC or the United States Government.
Raw data
{
"_id": null,
"home_page": "",
"name": "s100py",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "S-100,S-102,S-111,S-104,hydrographic",
"author": "",
"author_email": "Barry Gallagher <barry.gallagher@noaa.gov>, Erin Nagel <erin.nagel@noaa.gov>",
"download_url": "https://files.pythonhosted.org/packages/d3/b8/e8999c9ddae7598668b45dc5b5aac0249f48722ba383195e5667e2982dde/s100py-1.0.2.tar.gz",
"platform": null,
"description": "s100py\n======\n[](https://github.com/noaa-ocs-s100/s100py/actions/workflows/s100py-tests.yml)\n\nAPI and Utilities for Working with IHO S-100 HDF5 Data Formats\n\nOverview\n--------\n\nThis python package includes an API and utilities for encoding hydrographic\ndatasets in the International Hydrographic Organization (IHO) S-100\nHDF5 format.\n\nSee [s100py Read the Docs](https://s100py.readthedocs.io/en/latest/) for more information.\n\nBackground\n----------\n\nThe IHO S-100 standard is a data framework for digital products and\nservices for hydrographic, maritime, and GIS communities, comprised of\nmultiple data encoding formats designed for interoperability with\nElectronic Navigational Charts (ENCs).\n\nThis package includes the following S-100 encoding formats:\n\n- S-102 Bathymetric Surface \n- S-104 Water Level Information for Surface Navigation\n- S-111 Water Currents for Surface Navigation\n\nHowever, support for additional formats as they become available will\nbe added in the future. For further information about S-100 formats,\nsee the [IHO website](http://s100.iho.int/S100/).\n\nCreate S100 Products\n--------------------\n\n- Follow [S-102](https://s100py.readthedocs.io/en/latest/s102.html#) examples to create an S-102 File\n- Follow [S-104](https://s100py.readthedocs.io/en/latest/s104.html#) examples to create an S-104 File\n- Follow [S-111](https://s100py.readthedocs.io/en/latest/s111.html#) examples to create an S-111 File\n\nFor S100 API Developers\n-----------------------\n\n- [Extending the API](https://s100py.readthedocs.io/en/latest/extending_the_api.html)\n- [Example API](https://s100py.readthedocs.io/en/latest/sample_api.html)\n- [Using Example API](https://s100py.readthedocs.io/en/latest/using_sample_api.html)\n- [Advanced Example API Usage](https://s100py.readthedocs.io/en/latest/more_sample_api.html)\n\nRequirements\n------------\n\nThis codebase is written for Python >=3.8 and relies on the following python\npackages:\n\n- h5py\n- numpy\n- gdal\n\n\nInstallation\n------------\n\nConda\n-----\nInstalling s100py from the conda-forge channel can be achieved by adding conda-forge to your channels with:\n```bash\nconda config --add channels conda-forge\nconda config --set channel_priority strict\n```\nOnce the conda-forge channel has been enabled, s100py can be installed with conda:\n```bash\nconda install s100py\n```\nor with mamba:\n```bash\nmamba install s100py\n```\nIt is possible to list all the versions of s100py available on your platform with conda:\n```bash\nconda search s100py --channel conda-forge\n```\nor with mamba:\n```bash\nmamba search s100py --channel conda-forge\n```\nAlternatively, mamba repoquery may provide more information:\n\n**Search all versions available on your platform:**\n\n```bash\nmamba repoquery search s100py --channel conda-forge\n```\n**List packages depending on `s100py`:**\n```bash\nmamba repoquery whoneeds s100py --channel conda-forge\n```\n**List dependencies of `s100py`:**\n\n```bash\nmamba repoquery depends s100py --channel conda-forge\n```\n\nPIP\n---\n\nIf installing with PIP, this package requires GDAL Python bindings be present,\nso it usually can't be installed just using `pip install gdal`, but for more information\nvisit https://pypi.org/project/GDAL/.\n\nOnce `gdal` has been installed, s100py can be installed using `pip`:\n\n```bash\npip install s100py\n```\n\nRelease Notes\n-------------\n**Version 1.0.0 (2023-10-27)**\n- This is a major release, which includes several new APIs that encapsulate the latest S-100 standard (S-100 Edition 5.0.0)\nand S-100 Product Specifications (S-102 Edition 2.2.0, S-111 Edition 1.2.0, S-104 Edition 1.1.0) and adds support for\nmultiple S-100 Editions and Product Specification versions\n- Additional convenience utilities have been added to generate:\n * S-102 Edition 2.1.0 & 2.2.0 datasets\n * S-111 Edition 1.0.0 & 1.2.0 datasets\n * S-104 Edition 1.0.0 & 1.1.0 datasets\n * S-102 Data Coding Format 9 (Feature Oriented Regular Grid) datasets\n * S-104 Data Coding Format 3 (Irregular Grid) datasets\n * S-104 Data Coding Format 7 (TIN) datasets\n- S-102 Edition 2.1.0 (S-100 Edition 4.0) significant changes include:\n * The depth orientation has changed from positive up to positive down\n- S-102 Edition 2.2.0 (S-100 Edition 5.0) significant changes include:\n * General metadata _horizontalDatumReference_ and _horizontalDatumValue_ have been removed\n * General metadata attributes _horizontalCRS_ and _typeOfHorizontalCRS_ were added\n * Stricter datatypes have been set for all attributes\n * Added the feature attribute table _QualityOfSurvey_ which provides the following additional survey metadata:\n * The categorization of the assessment level of bathymetric data for an area\n * If the least depth of detected features in an area was measured\n * If significant features have or have not been detected in the course of a survey\n * The size of detected bathymetric features in an area\n * Percentage of depth that a feature of such size could be detected\n * If full seafloor coverage has been achieved in the area by hydrographic surveys\n * Flag for bathy coverage nodes populated by interpolation\n * The best estimate of the fixed horizontal or vertical accuracy component for positions, depths, heights, vertical\n distances, and vertical clearances\n * The factor to be applied to the variable component of uncertainty equation to provide the best estimate of the\n variable horizontal or vertically accuracy component for positions, depths, heights, vertical distances, and\n vertical clearances\n * The start date of the period of the hydrographic survey\n * The end date of the period of the hydrographic survey\n * The survey filename or ID\n * The authority which as responsible for the hydrographic survey\n * An estimate of the magnitude of the difference between true and estimated bathymetric depth, after all appropriate\n corrections are made\n- S-111 Edition 1.2.0 (S-100 Edition 5.0.0) significant changes include:\n * General metadata _horizontalDatumReference_ and _horizontalDatumValue_ have been removed\n * General metadata attributes _horizontalCRS_ and _typeOfHorizontalCRS_ were added\n * Stricter datatypes have been set for all attributes\n * General metadata attribute _depthTypeIndex_ has been modified to only allow _heightOrDepth_ or _layerAverage_\n * General metadata _datasetDeliveryInterval_ was added, describing the expected time interval between availability of\n successive datasets for time-varying data, formatted as an ISO 8601 duration (e.g. 'PnYnMnDTnHnMnS')\n * The enumeration attribute for the classification of data according the relationship between the time of its collection,\n generation or calculation of generation parameters, in relation the time of publication has been changed from\n _typeOfCurrentData_ to _dataDynamicity_\n- S-104 Edition 1.1.0 (S-100 Edition 5.0.0) significant changes include:\n * General metadata _horizontalDatumReference_ and _horizontalDatumValue_ have been removed\n * General metadata attributes _horizontalCRS_ and _typeOfHorizontalCRS_ were added\n * Stricter datatypes have been set for all attributes\n * General metadata _datasetDeliveryInterval_ was added, describing the expected time interval between availability of\n successive datasets for time-varying data, formatted as an ISO 8601 duration (e.g. 'PnYnMnDTnHnMnS')\n * The enumeration attribute for the classification of data according the relationship between the time of its collection,\n generation or calculation of generation parameters, in relation the time of publication has been changed from\n _typeOfWaterLevelData_ to _dataDynamicity_\n * General metadata _trendInterval_ was added, describing the interval in minutes over which trend at a particular time\n is calculated\n\n**Version 1.0.0-rc.1 (2021-02-11)**\n- This is a major release, which includes a new API that encapsulates the data specifications to allow\n introspection with Python to determine what data is available or should be and what data types would\n be acceptable. Convenience utilities are available to convert data into S102/S104/S111 so detailed\n knowledge of the S100 specs and APIs is not required in most cases\n- Support for s102 (bathymetry) and s104 (water levels) has been added\n- A consistent API for S100 data structures was added and is used to encode S102, S104, and S111\n- The previous S111 library has been migrated to this general S100 API and therefore any\n code written against the previous s100py library will no longer work\n- Examples of using the new S111 API are available [here](https://s100py.readthedocs.io/en/latest/s111.html#example-usage)\n\nAuthors\n-------\n\n- Barry Gallagher (NOAA), <barry.gallagher@noaa.gov>\n- Erin Nagel (UCAR), <erin.nagel@noaa.gov>\n- Glen Rice (NOAA), <glen.rice@noaa.gov>\n- Jason Greenlaw\n\n\nLicense\n-------\n\nThis work, as a whole, falls under Creative Commons Zero (see\n[LICENSE](LICENSE)).\n\nDisclaimer\n----------\n\nThis repository is a scientific product and is not official\ncommunication of the National Oceanic and Atmospheric Administration, or\nthe United States Department of Commerce. All NOAA GitHub project code\nis provided on an 'as is' basis and the user assumes responsibility for\nits use. Any claims against the Department of Commerce or Department of\nCommerce bureaus stemming from the use of this GitHub project will be\ngoverned by all applicable Federal law. Any reference to specific\ncommercial products, processes, or services by service mark, trademark,\nmanufacturer, or otherwise, does not constitute or imply their\nendorsement, recommendation or favoring by the Department of Commerce.\nThe Department of Commerce seal and logo, or the seal and logo of a DOC\nbureau, shall not be used in any manner to imply endorsement of any\ncommercial product or activity by DOC or the United States Government.\n",
"bugtrack_url": null,
"license": "",
"summary": "This python package provides api and utilities for encoding hydrographic datasets in the International Hydrographic Organization (IHO) S-100 format",
"version": "1.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/noaa-ocs-s100/s100py/issues/",
"Documentation": "https://s100py.readthedocs.io/en/latest/",
"Homepage": "https://github.com/noaa-ocs-s100/s100py",
"Source": "https://github.com/noaa-ocs-s100/s100py"
},
"split_keywords": [
"s-100",
"s-102",
"s-111",
"s-104",
"hydrographic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "227a32bb2635d40480a81d1b11c204df9b91787f0f07ccdd5c30f3c4cbc30f3b",
"md5": "b8931974d1da16ecdf73a3ee0fd35765",
"sha256": "ea2abc7458ca7732c3c233ab34137357aadc0a391ef1bda40040cb7a7f344d30"
},
"downloads": -1,
"filename": "s100py-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8931974d1da16ecdf73a3ee0fd35765",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 184978,
"upload_time": "2023-12-15T21:12:13",
"upload_time_iso_8601": "2023-12-15T21:12:13.674739Z",
"url": "https://files.pythonhosted.org/packages/22/7a/32bb2635d40480a81d1b11c204df9b91787f0f07ccdd5c30f3c4cbc30f3b/s100py-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d3b8e8999c9ddae7598668b45dc5b5aac0249f48722ba383195e5667e2982dde",
"md5": "87350574d3bbbf84e0904c6b693b5596",
"sha256": "677652e28401eae8ea567bdca8e45b52d87d5c5c96a6e682f69cd9f5b65188a3"
},
"downloads": -1,
"filename": "s100py-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "87350574d3bbbf84e0904c6b693b5596",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 411721,
"upload_time": "2023-12-15T21:12:15",
"upload_time_iso_8601": "2023-12-15T21:12:15.605021Z",
"url": "https://files.pythonhosted.org/packages/d3/b8/e8999c9ddae7598668b45dc5b5aac0249f48722ba383195e5667e2982dde/s100py-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 21:12:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "noaa-ocs-s100",
"github_project": "s100py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "s100py"
}
