| Name | bathyreq JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | BathyReq: A Python package for querying public bathymetric data sources. |
| upload_time | 2024-10-11 19:52:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023-2024 William Jenkins 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
oceanography
data
query
download
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# BathyReq
[](https://zenodo.org/badge/latestdoi/679471492)
<div align="center"> <img src="docs/docs/assets/banner.png"> </div>
A Python package for querying public bathymetric data sources.
Currently only digital elevation model (DEM) data from the [NOAA National Centers for Environmental Information (NCEI)](https://www.ncei.noaa.gov/) database is supported.
Future development will focus on implementing other sources, such as the [General Bathymetric Chart of the Oceans (GEBCO)](https://www.gebco.net) and NOAA's new [Blue Topo](https://nauticalcharts.noaa.gov/data/bluetopo.html) project.
## Installation
```bash
pip install bathyreq
```
## Usage
Download bathymetric data for a given area:
```python
import bathyreq
req = bathyreq.BathyRequest()
data, lonvec, latvec = req.get_area(
longitude=[-117.43, -117.23], latitude=[32.55, 32.75]
)
```
Download bathymetric data for a single longitude/latitude pair:
```python
import bathyreq
req = bathyreq.BathyRequest()
data = req.get_point(
longitude=-117.43, latitude=32.75
)
```
## Methods not yet implemented
Download bathymetric data for a given set of longitude/latitude pairs:
```python
import bathyreq
req = bathyreq.BathyRequest()
data = req.get_points(
longitude=[-117.43, -117.23], latitude=[32.55, 32.75]
)
```
Download bathymetric data for a given profile between two longitude/latitude pairs:
```python
import bathyreq
req = bathyreq.BathyRequest()
data = req.get_profile(
longitude=[-117.43, -117.23], latitude=[32.55, 32.75]
)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "bathyreq",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "bathymetry, oceanography, data, query, download",
"author": null,
"author_email": "William Jenkins <wjenkins@ucsd.edu>",
"download_url": "https://files.pythonhosted.org/packages/77/5f/c228c8c72258bc0747b884c2fdbb2e211f0114b5ef8fd1707d74df787eb9/bathyreq-1.1.0.tar.gz",
"platform": null,
"description": "# BathyReq\n\n[](https://zenodo.org/badge/latestdoi/679471492)\n\n<div align=\"center\"> <img src=\"docs/docs/assets/banner.png\"> </div>\n\nA Python package for querying public bathymetric data sources.\nCurrently only digital elevation model (DEM) data from the [NOAA National Centers for Environmental Information (NCEI)](https://www.ncei.noaa.gov/) database is supported.\nFuture development will focus on implementing other sources, such as the [General Bathymetric Chart of the Oceans (GEBCO)](https://www.gebco.net) and NOAA's new [Blue Topo](https://nauticalcharts.noaa.gov/data/bluetopo.html) project.\n\n## Installation\n```bash\npip install bathyreq\n```\n\n## Usage\n\nDownload bathymetric data for a given area:\n```python\nimport bathyreq\n\nreq = bathyreq.BathyRequest()\ndata, lonvec, latvec = req.get_area(\n longitude=[-117.43, -117.23], latitude=[32.55, 32.75]\n)\n```\n\nDownload bathymetric data for a single longitude/latitude pair:\n```python\nimport bathyreq\n\nreq = bathyreq.BathyRequest()\ndata = req.get_point(\n longitude=-117.43, latitude=32.75\n)\n```\n\n## Methods not yet implemented\n\nDownload bathymetric data for a given set of longitude/latitude pairs:\n```python\nimport bathyreq\n\nreq = bathyreq.BathyRequest()\ndata = req.get_points(\n longitude=[-117.43, -117.23], latitude=[32.55, 32.75]\n)\n```\n\nDownload bathymetric data for a given profile between two longitude/latitude pairs:\n```python\nimport bathyreq\n\nreq = bathyreq.BathyRequest()\ndata = req.get_profile(\n longitude=[-117.43, -117.23], latitude=[32.55, 32.75]\n)\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023-2024 William Jenkins 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": "BathyReq: A Python package for querying public bathymetric data sources.",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://neptuneprojects.github.io/BathyReq/",
"Repository": "https://github.com/NeptuneProjects/BathyReq"
},
"split_keywords": [
"bathymetry",
" oceanography",
" data",
" query",
" download"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e1f8b4828078c0cc338efc459d9c1356f46fee16f0f727bc3a2ab1580b7129ff",
"md5": "6f80b48ef1156614e96472a693e5eec0",
"sha256": "1f263392028fb631f06008aa24d9eaff0b32e8c4f11a4d0a2ce4194c5bcae671"
},
"downloads": -1,
"filename": "bathyreq-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f80b48ef1156614e96472a693e5eec0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 14114,
"upload_time": "2024-10-11T19:52:47",
"upload_time_iso_8601": "2024-10-11T19:52:47.063057Z",
"url": "https://files.pythonhosted.org/packages/e1/f8/b4828078c0cc338efc459d9c1356f46fee16f0f727bc3a2ab1580b7129ff/bathyreq-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "775fc228c8c72258bc0747b884c2fdbb2e211f0114b5ef8fd1707d74df787eb9",
"md5": "696af241a52a6fe255c8c7a707aae6f8",
"sha256": "2bf13672114f0fc7d2b80645b5f0480c27631c0faca23f08a606314d87854bfc"
},
"downloads": -1,
"filename": "bathyreq-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "696af241a52a6fe255c8c7a707aae6f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10710,
"upload_time": "2024-10-11T19:52:48",
"upload_time_iso_8601": "2024-10-11T19:52:48.034824Z",
"url": "https://files.pythonhosted.org/packages/77/5f/c228c8c72258bc0747b884c2fdbb2e211f0114b5ef8fd1707d74df787eb9/bathyreq-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-11 19:52:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NeptuneProjects",
"github_project": "BathyReq",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "bathyreq"
}
