flowfabricpy

Functions

auto_streamflow_params(dataset_id)

Auto-generate streamflow parameters for a given dataset

flowfabric_get(endpoint[, token, verbose])

HTTP GET request using the flowfabric API

flowfabric_get_dataset(dataset_id)

Get information on a specific dataset

flowfabric_get_latest_run(dataset_id[, verbose])

Get the latest run from a dataset

flowfabric_get_token([force_refresh])

Get and cache an authentication token

flowfabric_healthz([token, verbose])

Return health status of the API

flowfabric_inundation_ids([params, verbose])

Return inundation polygon grid ids

flowfabric_list_datasets()

List all available datasets

flowfabric_post(endpoint, body[, token, verbose])

HTTP POST request using the flowfabric API

flowfabric_ratings_estimate(feature_ids[, ...])

Estimate size of REM ratings data

flowfabric_ratings_query(feature_ids[, ...])

Query REM ratings (stage-discharge relationship)

flowfabric_refresh_token()

Force refresh the cached token

flowfabric_stage_query(dataset_id[, params, ...])

Query stage data (Arrow IPC)

flowfabric_streamflow_estimate(dataset_id[, ...])

Estimate size of streamflow data for a dataset using given or auto-generated parameters

flowfabric_streamflow_query(dataset_id[, ...])

Query streamflow for a dataset using given or auto-generated parameters

get_bearer_token([force_refresh])

Get a JWT bearer token

Modules

auth

Functions for getting an authentication token

catalog_utils

Contains a function to get recommended streamflow parameters.

client

Main functions for interacting with the flowfabric client

flowfabric_http

Functions for GET and POST requests using the flowfabric API