# freezebase

> Lightweight geospatial helpers for reproducible MGRS grids and S3-backed raster workflows.

## Docs

### API Reference

#### MGRS grid
> 10 km MGRS grid squares to align raster data onto one common grid.

- [mgrs.MGRSGrid](https://lqgentner.github.io/freezebase/reference/mgrs.MGRSGrid.html)
- [mgrs.MGRSGeoBox](https://lqgentner.github.io/freezebase/reference/mgrs.MGRSGeoBox.html)
- [mgrs.UTMZones](https://lqgentner.github.io/freezebase/reference/mgrs.UTMZones.html)
- [mgrs.mgrs_to_crs](https://lqgentner.github.io/freezebase/reference/mgrs.mgrs_to_crs.html)
- [mgrs.utm_to_crs](https://lqgentner.github.io/freezebase/reference/mgrs.utm_to_crs.html)
- [mgrs.utms_to_epsgs](https://lqgentner.github.io/freezebase/reference/mgrs.utms_to_epsgs.html)
- [mgrs.transform_shapely](https://lqgentner.github.io/freezebase/reference/mgrs.transform_shapely.html)

#### Raster I/O
> rasterio helpers that accept local paths and `s3://` URIs via UPath.

- [raster.rasterio_open](https://lqgentner.github.io/freezebase/reference/raster.rasterio_open.html)
- [raster.rewrite_tiff](https://lqgentner.github.io/freezebase/reference/raster.rewrite_tiff.html)
- [raster.write_cog](https://lqgentner.github.io/freezebase/reference/raster.write_cog.html)
- [raster.merge_tiffs](https://lqgentner.github.io/freezebase/reference/raster.merge_tiffs.html)
- [raster.build_rasterio_profile](https://lqgentner.github.io/freezebase/reference/raster.build_rasterio_profile.html)
- [raster.group_tiffs_by_crs](https://lqgentner.github.io/freezebase/reference/raster.group_tiffs_by_crs.html)
- [raster.get_utm_zone_string](https://lqgentner.github.io/freezebase/reference/raster.get_utm_zone_string.html)
- [raster.get_epsg_string](https://lqgentner.github.io/freezebase/reference/raster.get_epsg_string.html)
- [raster.utm_zone_to_crs](https://lqgentner.github.io/freezebase/reference/raster.utm_zone_to_crs.html)
- [raster.COG_PROFILE](https://lqgentner.github.io/freezebase/reference/raster.COG_PROFILE.html)
- [raster.RASTERIO_PROFILE_DEFAULTS](https://lqgentner.github.io/freezebase/reference/raster.RASTERIO_PROFILE_DEFAULTS.html)

#### VRT generation
> Build VRT files without the Python GDAL dependency

- [vrt.create_decibel_vrt](https://lqgentner.github.io/freezebase/reference/vrt.create_decibel_vrt.html)
- [vrt.create_rgb_vrt](https://lqgentner.github.io/freezebase/reference/vrt.create_rgb_vrt.html)
- [vrt.build_vrt_mosaic](https://lqgentner.github.io/freezebase/reference/vrt.build_vrt_mosaic.html)

#### Downloads
> HTTP downloads with UPath destinations

- [download.HTTPDownloader](https://lqgentner.github.io/freezebase/reference/download.HTTPDownloader.html)
- [download.retry_request](https://lqgentner.github.io/freezebase/reference/download.retry_request.html)

#### S3
> S3 `UPath` construction and retry configuration

- [s3.make_s3_upath](https://lqgentner.github.io/freezebase/reference/s3.make_s3_upath.html)
- [s3.s3_env](https://lqgentner.github.io/freezebase/reference/s3.s3_env.html)

#### Vector data
> Cached vector datasets and GeoDataFrame helpers

- [vectordata.GeoVectorData](https://lqgentner.github.io/freezebase/reference/vectordata.GeoVectorData.html)
- [vectordata.DatasetMetadata](https://lqgentner.github.io/freezebase/reference/vectordata.DatasetMetadata.html)
- [vectools.save_and_read_parquet](https://lqgentner.github.io/freezebase/reference/vectools.save_and_read_parquet.html)
- [vectools.drop_z_if_zero](https://lqgentner.github.io/freezebase/reference/vectools.drop_z_if_zero.html)
- [vectools.is_z_axis_zero](https://lqgentner.github.io/freezebase/reference/vectools.is_z_axis_zero.html)
- [vectools.simplify_multipolygons](https://lqgentner.github.io/freezebase/reference/vectools.simplify_multipolygons.html)

#### Utilities
> Shared helpers used across the package

- [set_loglevel](https://lqgentner.github.io/freezebase/reference/set_loglevel.html): Configure freezebase's logging levels
- [utils.get_cache_dir](https://lqgentner.github.io/freezebase/reference/utils.get_cache_dir.html)
- [utils.get_data_dir](https://lqgentner.github.io/freezebase/reference/utils.get_data_dir.html)
- [utils.get_credentials_from_env](https://lqgentner.github.io/freezebase/reference/utils.get_credentials_from_env.html)
- [utils.depends_on_optional](https://lqgentner.github.io/freezebase/reference/utils.depends_on_optional.html)
- [utils.file_sha256](https://lqgentner.github.io/freezebase/reference/utils.file_sha256.html)
- [utils.shorten_string](https://lqgentner.github.io/freezebase/reference/utils.shorten_string.html)
- [utils.format_valid_options](https://lqgentner.github.io/freezebase/reference/utils.format_valid_options.html)
- [pandas_utils.clean_names](https://lqgentner.github.io/freezebase/reference/pandas_utils.clean_names.html)
- [progress.create_progress](https://lqgentner.github.io/freezebase/reference/progress.create_progress.html)
- [progress.track_progress](https://lqgentner.github.io/freezebase/reference/progress.track_progress.html)