ripple1d.stacio package#

Submodules#

ripple1d.stacio.fim_collection module#

FIM Collection.

class ripple1d.stacio.fim_collection.FIMCollection(stac_api, collection_id, connect=True)#

Bases: object

Class for interacting with a FIM collection in a STAC API.

add_branch_conflation_asset(asset_id, asset_key, roles=application / geopackage + sqlite3, bucket='fim')#: Add a branch conflation asset to the collection.

load()#

Load the collection from the STAC API.

Return type:: Collection

post_collection_updates()#: Post collection updates to the STAC API.

class ripple1d.stacio.fim_collection.FIMCollectionRasDGItem(stac_api, collection_id, item_id, load=True)#

Bases: FIMCollection

Class for interacting with a FIM collection RAS Depth Grid item in a STAC API.

Not Implemented

load_item()#

Load the item from the STAC API.

Return type:: Item

class ripple1d.stacio.fim_collection.FIMCollectionRasItem(stac_api, collection_id, item_id, connect=False, load=True, local_item=None)#

Bases: FIMCollection

Class for interacting with a FIM collection RAS item in a STAC API.

add_ripple1d_params(date_created='2025-01-21T18:11:23.619254', software='ripple1d v0.1.0-alpha.1', asset_role='project-file', bucket='fim')#

TODO: Placeholder function for adding ripple1d-params to FIM collection items.

This assumes the conflation output is in the same directory as the project-file asset

Return type:: bool

add_s3_key_to_assets(bucket='fim')#: Add the s3_key to the assets in the item.

ensure_asset_roles_unique(bucket='fim')#: Ensure that the asset roles are unique.

load_item()#

Load the item from the STAC API.

Return type:: Item

map_topo_assets(date_aquired='2025-01-21T18:11:23.619242', software='ripple1d v0.1.0-alpha.1', topo_filename='MapTerrain', asset_role='ras-geometry-gpkg', source='USGS_Seamless_DEM_13')#

TODO: Placeholder function for mapping topo assets to FIM collection items.

This assumes the topo assets are in the same directory as the ras-geometry-gpkg asset

post_item_updates()#: Post item updates to the STAC API.

sanitize_ras_stac_props()#

TODO: Placeholder function for sanitizing RAS STAC properties.

Need to update ras-stac and remove this method here or convert to a check.

ripple1d.stacio.ras_dgs_to_mip_collection module#

Script is a prototype for creating a STAC collection for the FIM depth grids.

TODO: Refactor, this script was written in one setting and needs to be revised significantly.

ripple1d.stacio.ras_items_to_mip_collection module#

Adds RAS Items to a STAC collection.

TODO: Refactor, this script was written in one setting and needs to be revised significantly.

ripple1d.stacio.update_mip_collection_for_ripple module#

Update existing collection.

TODO: Refactor, this script was written in one setting and needs to be revised significantly.

Module contents#

Initialize stacio.