Background • Requirements • Installation • Quickstart • CLI • Notes • Contact
Overview
This package simplifies getting BlueTopo data in your area of interest.
Background
BlueTopo is a compilation of the best available public bathymetric data of U.S. waters.
Created by NOAA Office of Coast Survey's National Bathymetric Source project, BlueTopo data intends to provide depth information nationwide with the vertical uncertainty tied to that depth estimate as well as information on the survey source that it originated from.
This data is presented in a multiband high resolution GeoTIFF with an associated raster attribute table.
For answers to frequently asked questions, visit the FAQ.
Requirements
This codebase is written for Python 3 and relies on the following python packages:
- gdal / ogr
- numpy
- boto3
- tqdm
Installation
Install conda (If you have not already): conda installation
In the command line, create an environment with the required packages:
conda create -n bluetopo_env -c conda-forge 'gdal>=3.4'
conda activate bluetopo_env
pip install bluetopo
Quickstart
To download the desired files, first create a geometry file (such as a geopackage) with a polygon depicting the area of interest. Then run the following commands inside of a Python shell:
from nbs.bluetopo import fetch_tiles
fetch_tiles(r'C:\download_path', 'area_of_interest.gpkg')
To build a GDAL VRT of the downloaded tiles:
from nbs.bluetopo import build_vrt
build_vrt(r'C:\download_path')
CLI
You can also use the command line. Confirm the environment we created during installation is activated.
To fetch the latest BlueTopo data, use fetch_tiles passing a directory path and a geometry file path with a polygon depicting your area of interest:
fetch_tiles -d [DIRECTORY PATH] -g [GEOMETRY FILE PATH]
Pass the same directory path to build_vrt to create a VRT from the fetched data:
build_vrt -d [DIRECTORY PATH]
Use -h for help and to see additional arguments.
For most usecases, reusing the commands above to stay up to date in your area of interest is adequate.
Notes
In addition to BlueTopo, modeling data is available. You can work with modeling data using the source argument in the CLI commands or the data_source argument if you're calling the function directly.
The primary difference between BlueTopo and modeling data is the vertical datum. Modeling data is on a low water datum.
Authors
-
Glen Rice (NOAA), ocs.nbs@noaa.gov
-
Tashi Geleg (Lynker / NOAA), ocs.nbs@noaa.gov
License
This work, as a whole, falls under Creative Commons Zero (see 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.
Metadata
Release files for BlueTopo 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bluetopo-0.7.0.tar.gz | 29.7 kB | Without provenance | Details for bluetopo-0.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| BlueTopo-0.7.0-py3-none-any.whl | Python 3 | none | any | Details for BlueTopo-0.7.0-py3-none-any.whl |
Total release size: 60.5 kB
Release files / bluetopo-0.7.0.tar.gz
| Download URL | bluetopo-0.7.0.tar.gz |
|---|---|
| Size | 29.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
732abf26c0842c4d01fae92789e8ce29101652959bd5212b193f2aec5b617b08
|
|
BLAKE2b-256 checksum How to use checksums |
031f1d43fbfc2fb72b6056ad7bd0c59f8d85916a0dda8171912cd950a5feda00
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.20
|
Release files / BlueTopo-0.7.0-py3-none-any.whl
| Download URL | BlueTopo-0.7.0-py3-none-any.whl |
|---|---|
| Size | 30.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c2833d581f2c786e1848ca98dc4c31e6ca1ef23ab1efe96602bb5ada282edf5e
|
|
BLAKE2b-256 checksum How to use checksums |
1b9c3c7b16a42d8f688949c1062b52b434b92898b938084f2284da554d523ff1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.20
|
Security for BlueTopo 0.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.