| Name | vyperdatum JSON |
| Version |
0.3.2
JSON |
| download |
| home_page | None |
| Summary | https://vyperdatum.readthedocs.io/en/latest/ |
| upload_time | 2024-09-14 09:33:40 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 NOAA Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 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
pip install vyperdatum
```
## 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 or let the `Pipeline` class
```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).linear_steps()
# steps=Pipeline(crs_from=crs_from, crs_to=crs_to).graph_steps()
)
```
### raster transform
```python
tf.transform_raster(input_file=<PATH_TO_INPUT_RASTER_FILE>,
output_file=<PATH_TO_OUTPUT_RASTER_FILE>
)
```
### point transform
```python
# random values
x, y, z = 278881.198, 2719890.433, 0
xt, yt, zt = tf.transform_points(x, y, z, always_xy=True, allow_ballpark=False)
```
## 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/ca/ae/5f6cca9f9b99dd59fed31e49d24b46a605245cc814049e3b9cf6932c7c79/vyperdatum-0.3.2.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\npip install vyperdatum\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 or let the `Pipeline` class \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).linear_steps()\r\n # steps=Pipeline(crs_from=crs_from, crs_to=crs_to).graph_steps() \r\n )\r\n```\r\n### raster transform \r\n```python \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\r\n### point transform \r\n```python\r\n# random values\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\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": "MIT License Copyright (c) 2024 NOAA Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "https://vyperdatum.readthedocs.io/en/latest/",
"version": "0.3.2",
"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": "4a59ef8f5edec6652572d319fc5b26a58b139a3dc1474a62b39a54fbaea0ef93",
"md5": "2850aaa95f82e558ec4b81dcbaca6dc1",
"sha256": "3faac3777fefff894995b23b7b0df1d3eb7a71af6f471d182fe7d9f82c1c9b2c"
},
"downloads": -1,
"filename": "vyperdatum-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2850aaa95f82e558ec4b81dcbaca6dc1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3739,
"upload_time": "2024-09-14T09:33:38",
"upload_time_iso_8601": "2024-09-14T09:33:38.772440Z",
"url": "https://files.pythonhosted.org/packages/4a/59/ef8f5edec6652572d319fc5b26a58b139a3dc1474a62b39a54fbaea0ef93/vyperdatum-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "caae5f6cca9f9b99dd59fed31e49d24b46a605245cc814049e3b9cf6932c7c79",
"md5": "1b08acb27c20a093bdd11dfd0593cd1e",
"sha256": "7b0d57f7b6b5f6fd395df54130ddc53c2d7586e706fd89cea0d2cc827e987576"
},
"downloads": -1,
"filename": "vyperdatum-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "1b08acb27c20a093bdd11dfd0593cd1e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 39902,
"upload_time": "2024-09-14T09:33:40",
"upload_time_iso_8601": "2024-09-14T09:33:40.607026Z",
"url": "https://files.pythonhosted.org/packages/ca/ae/5f6cca9f9b99dd59fed31e49d24b46a605245cc814049e3b9cf6932c7c79/vyperdatum-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-14 09:33:40",
"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"
}
