| Name | vyperdatum JSON |
| Version |
0.3.14
JSON |
| download |
| home_page | None |
| Summary | Vyperdatum with built-in regional datums, proj.db, and vdatum vector files. |
| upload_time | 2024-11-22 21:20:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Creative Commons Legal Code CC0 1.0 Universal CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER. Statement of Purpose The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work"). Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. 1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following: i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; ii. moral rights retained by the original author(s) and/or performer(s); iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; v. rights protecting the extraction, dissemination, use and reuse of data in a Work; vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. 2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. 3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. 4. Limitations and Disclaimers. a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work. |
| keywords |
bathymetry
datum
noaa
nbs
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img align="right" src="https://upload.wikimedia.org/wikipedia/commons/7/79/NOAA_logo.svg" width="100">
<br/>
[](https://badge.fury.io/py/vyperdatum)
[](https://zenodo.org/doi/10.5281/zenodo.13345073)
[](https://vyperdatum.readthedocs.io/en/latest/)
## Vyperdatum
**Vyperdatum** [definition]
## Installation
Vyperdatum requires `GDAL` which can be installed from the conda's conda-forge channel. Below, we first create a conda environment, install `GDAL` and Vperdatum.
```bash
conda create -n vd python=3.11
conda activate vd
conda install -c conda-forge gdal=3.8.4
conda install -c conda-forge python-pdal
pip install vyperdatum
```
Before running vyperdatum, you need to copy NOAA's datum files and the updated `proj.db` into the PROJ data directory [download link will be added here]. This process may get automated in the future. The Proj data directory path can be found here:
```python
import pyproj as pp
pp.datadir.get_data_dir()
```
## Usage
Vyperdatum offers a `Transformer` class to handle the transformation of point and raster data. The `Transformer` class applies transformation from `crs_from` to `crs_to` coordinate reference systems. The transformation steps can be prescribed manually or let the `Pipeline` class to infer:
```python
from vyperdatum.transformer import Transformer
from vyperdatum.pipeline import Pipeline
crs_from = "EPSG:6346"
crs_to = "EPSG:6346+NOAA:5224"
tf = Transformer(crs_from=crs_from,
crs_to=crs_to,
steps=["EPSG:6346", "EPSG:6319", "EPSG:6318+NOAA:5224", "EPSG:6346+NOAA:5224"]
# steps=Pipeline(crs_from=crs_from, crs_to=crs_to).transformation_steps()
)
```
Once an instance of the `Transformer` class is created, the `transform()` method can be called. Vyperdatum supports all GDAL-supported drivers, variable resolution BAG, LAZ and NPZ point-cloud files.
### transform
```python
tf.transform(input_file=<PATH_TO_INPUT_RASTER_FILE>,
output_file=<PATH_TO_OUTPUT_RASTER_FILE>
)
```
You may also, directly call the file-specific transform methods instead of the generic `Transformer.transform()` method:
<details>
<summary>Click to see pseudo-code examples</summary>
```python
# dircet point transformation. x, y, z can be arrays, too.
x, y, z = 278881.198, 2719890.433, 0
xt, yt, zt = tf.transform_points(x, y, z, always_xy=True, allow_ballpark=False)
# GDAL-supported raster transform
tf.transform_raster(input_file=<PATH_TO_INPUT_RASTER_FILE>,
output_file=<PATH_TO_OUTPUT_RASTER_FILE>
)
# VRBAG transform
tf.transform_vrbag(input_file=<PATH_TO_INPUT_VRBAG_FILE>,
output_file=<PATH_TO_OUTPUT_VRBAG_FILE>
)
# LAZ transform
tf.transform_laz(input_file=<PATH_TO_INPUT_LAZ_FILE>,
output_file=<PATH_TO_OUTPUT_LAZ_FILE>
)
# NPZ transform
tf.transform_npz(input_file=<PATH_TO_INPUT_NPZ_FILE>,
output_file=<PATH_TO_OUTPUT_NPZ_FILE>
)
```
</details>
## Documentation
For a quick start, more detailed descriptions or search through the API, see Vyperdatums's documentation at: https://vyperdatum.readthedocs.io.
Raw data
{
"_id": null,
"home_page": null,
"name": "vyperdatum",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "bathymetry, datum, NOAA, NBS",
"author": null,
"author_email": "Mohammad Ashkezari <mohammad.ashkezari@noaa.gov>",
"download_url": "https://files.pythonhosted.org/packages/c5/01/63556eeabe2f1f37742f5a5af783ef323404749fe0185ab491d4b307ddcd/vyperdatum-0.3.14.tar.gz",
"platform": null,
"description": "<img align=\"right\" src=\"https://upload.wikimedia.org/wikipedia/commons/7/79/NOAA_logo.svg\" width=\"100\">\r\n<br/>\r\n\r\n[](https://badge.fury.io/py/vyperdatum)\r\n[](https://zenodo.org/doi/10.5281/zenodo.13345073)\r\n[](https://vyperdatum.readthedocs.io/en/latest/)\r\n\r\n## Vyperdatum\r\n\r\n**Vyperdatum** [definition] \r\n\r\n## Installation\r\nVyperdatum requires `GDAL` which can be installed from the conda's conda-forge channel. Below, we first create a conda environment, install `GDAL` and Vperdatum.\r\n\r\n```bash\r\nconda create -n vd python=3.11\r\nconda activate vd\r\nconda install -c conda-forge gdal=3.8.4\r\nconda install -c conda-forge python-pdal\r\npip install vyperdatum\r\n```\r\nBefore running vyperdatum, you need to copy NOAA's datum files and the updated `proj.db` into the PROJ data directory [download link will be added here]. This process may get automated in the future. The Proj data directory path can be found here:\r\n\r\n```python\r\nimport pyproj as pp\r\npp.datadir.get_data_dir()\r\n```\r\n\r\n## Usage\r\nVyperdatum offers a `Transformer` class to handle the transformation of point and raster data. The `Transformer` class applies transformation from `crs_from` to `crs_to` coordinate reference systems. The transformation steps can be prescribed manually or let the `Pipeline` class to infer:\r\n\r\n```python\r\nfrom vyperdatum.transformer import Transformer\r\nfrom vyperdatum.pipeline import Pipeline\r\n\r\ncrs_from = \"EPSG:6346\"\r\ncrs_to = \"EPSG:6346+NOAA:5224\"\r\ntf = Transformer(crs_from=crs_from,\r\n crs_to=crs_to,\r\n steps=[\"EPSG:6346\", \"EPSG:6319\", \"EPSG:6318+NOAA:5224\", \"EPSG:6346+NOAA:5224\"]\r\n # steps=Pipeline(crs_from=crs_from, crs_to=crs_to).transformation_steps()\r\n )\r\n```\r\n\r\nOnce an instance of the `Transformer` class is created, the `transform()` method can be called. Vyperdatum supports all GDAL-supported drivers, variable resolution BAG, LAZ and NPZ point-cloud files.\r\n\r\n### transform\r\n```python \r\ntf.transform(input_file=<PATH_TO_INPUT_RASTER_FILE>,\r\n output_file=<PATH_TO_OUTPUT_RASTER_FILE>\r\n )\r\n```\r\n\r\nYou may also, directly call the file-specific transform methods instead of the generic `Transformer.transform()` method:\r\n\r\n<details>\r\n<summary>Click to see pseudo-code examples</summary>\r\n \r\n```python\r\n# dircet point transformation. x, y, z can be arrays, too.\r\nx, y, z = 278881.198, 2719890.433, 0\r\nxt, yt, zt = tf.transform_points(x, y, z, always_xy=True, allow_ballpark=False)\r\n\r\n# GDAL-supported raster transform \r\ntf.transform_raster(input_file=<PATH_TO_INPUT_RASTER_FILE>,\r\n output_file=<PATH_TO_OUTPUT_RASTER_FILE>\r\n )\r\n\r\n# VRBAG transform\r\ntf.transform_vrbag(input_file=<PATH_TO_INPUT_VRBAG_FILE>,\r\n output_file=<PATH_TO_OUTPUT_VRBAG_FILE>\r\n )\r\n\r\n# LAZ transform\r\ntf.transform_laz(input_file=<PATH_TO_INPUT_LAZ_FILE>,\r\n output_file=<PATH_TO_OUTPUT_LAZ_FILE>\r\n )\r\n\r\n# NPZ transform\r\ntf.transform_npz(input_file=<PATH_TO_INPUT_NPZ_FILE>,\r\n output_file=<PATH_TO_OUTPUT_NPZ_FILE>\r\n )\r\n```\r\n</details>\r\n\r\n## Documentation\r\n\r\nFor a quick start, more detailed descriptions or search through the API, see Vyperdatums's documentation at: https://vyperdatum.readthedocs.io.\r\n",
"bugtrack_url": null,
"license": "Creative Commons Legal Code CC0 1.0 Universal CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN \"AS-IS\" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER. Statement of Purpose The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an \"owner\") of an original work of authorship and/or a database (each, a \"Work\"). Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works (\"Commons\") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the \"Affirmer\"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. 1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights (\"Copyright and Related Rights\"). Copyright and Related Rights include, but are not limited to, the following: i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; ii. moral rights retained by the original author(s) and/or performer(s); iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; v. rights protecting the extraction, dissemination, use and reuse of data in a Work; vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. 2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the \"Waiver\"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. 3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the \"License\"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. 4. Limitations and Disclaimers. a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work.",
"summary": "Vyperdatum with built-in regional datums, proj.db, and vdatum vector files.",
"version": "0.3.14",
"project_urls": {
"Documentation": "https://vyperdatum.readthedocs.io/en/latest/",
"Repository": "https://github.com/mohammadashkezari-noaa/vyperdatum"
},
"split_keywords": [
"bathymetry",
" datum",
" noaa",
" nbs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "50cf739a48774d1c48e5757ed62ed6fb76d6cffd5af164e5e8858c6ffb5c1983",
"md5": "60612afd4ad53dc3f4c234dfa95527a1",
"sha256": "d510dc562ad899dfb6e733b68f22bc4d358a0e8157e5c9cca53e080611840a84"
},
"downloads": -1,
"filename": "vyperdatum-0.3.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "60612afd4ad53dc3f4c234dfa95527a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 237434,
"upload_time": "2024-11-22T21:20:18",
"upload_time_iso_8601": "2024-11-22T21:20:18.667717Z",
"url": "https://files.pythonhosted.org/packages/50/cf/739a48774d1c48e5757ed62ed6fb76d6cffd5af164e5e8858c6ffb5c1983/vyperdatum-0.3.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c50163556eeabe2f1f37742f5a5af783ef323404749fe0185ab491d4b307ddcd",
"md5": "5f66b1ff950d7af8ae73943f08b9855b",
"sha256": "8efdf245c7bd54ea20a8bbc39960ddc4596c4565b7b01338297a93a582f2ccd7"
},
"downloads": -1,
"filename": "vyperdatum-0.3.14.tar.gz",
"has_sig": false,
"md5_digest": "5f66b1ff950d7af8ae73943f08b9855b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 194205,
"upload_time": "2024-11-22T21:20:21",
"upload_time_iso_8601": "2024-11-22T21:20:21.587659Z",
"url": "https://files.pythonhosted.org/packages/c5/01/63556eeabe2f1f37742f5a5af783ef323404749fe0185ab491d4b307ddcd/vyperdatum-0.3.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 21:20:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mohammadashkezari-noaa",
"github_project": "vyperdatum",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "vyperdatum"
}
