femic.bcdc_dwds

DWDS fallback helpers for BC Data Catalogue feature-type orders.

exception femic.bcdc_dwds.BcdcDwdsError[source]

Bases: RuntimeError

Raised when a DWDS fallback order cannot be created or interpreted.

class femic.bcdc_dwds.BcdcDwdsOrderResult(query, limit, generated_utc, package_id, package_name, package_title, dataset_page_url, resource_id, resource_name, resource_url, feature_type, matched_by, aoi_source, bbox_epsg3005, geomark_id, geomark_url, output_format, email_address, clipping_method, ordering_application, request_url, request_payload, order_id, order_guid, submission_status, submission_description, submission_value, status_probe, warnings=(), latest_followup_utc=None, latest_followup_status_probe=None, latest_followup_pickup_url=None, latest_followup_pickup_download_url=None, materialized_artifact_path=None, materialized_download_url=None, materialized_content_type=None, materialized_bytes=None, followup_warnings=())[source]

Bases: object

One DWDS order submission result for a resolved BCDC query.

Parameters:

  • query (str)

  • limit (int)

  • generated_utc (str)

  • package_id (str)

  • package_name (str)

  • package_title (str)

  • dataset_page_url (str)

  • resource_id (str)

  • resource_name (str)

  • resource_url (str | None)

  • feature_type (str)

  • matched_by (str)

  • aoi_source (str)

  • bbox_epsg3005 (tuple[float, float, float, float])

  • geomark_id (str | None)

  • geomark_url (str | None)

  • output_format (str)

  • email_address (str | None)

  • clipping_method (str)

  • ordering_application (str)

  • request_url (str)

  • request_payload (dict[str, object])

  • order_id (str)

  • order_guid (str | None)

  • submission_status (str)

  • submission_description (str)

  • submission_value (str | None)

  • status_probe (BcdcDwdsStatusProbe | None)

  • warnings (tuple[str, ...])

  • latest_followup_utc (str | None)

  • latest_followup_status_probe (BcdcDwdsStatusProbe | None)

  • latest_followup_pickup_url (str | None)

  • latest_followup_pickup_download_url (str | None)

  • materialized_artifact_path (str | None)

  • materialized_download_url (str | None)

  • materialized_content_type (str | None)

  • materialized_bytes (int | None)

  • followup_warnings (tuple[str, ...])

aoi_source: str
bbox_epsg3005: tuple[float, float, float, float]
clipping_method: str
dataset_page_url: str
email_address: str | None
feature_type: str
followup_warnings: tuple[str, ...] = ()
generated_utc: str
geomark_id: str | None
geomark_url: str | None
latest_followup_pickup_download_url: str | None = None
latest_followup_pickup_url: str | None = None
latest_followup_status_probe: BcdcDwdsStatusProbe | None = None
latest_followup_utc: str | None = None
limit: int
matched_by: str
materialized_artifact_path: str | None = None
materialized_bytes: int | None = None
materialized_content_type: str | None = None
materialized_download_url: str | None = None
order_guid: str | None
order_id: str
ordering_application: str
output_format: str
package_id: str
package_name: str
package_title: str
query: str
request_payload: dict[str, object]
request_url: str
resource_id: str
resource_name: str
resource_url: str | None
status_probe: BcdcDwdsStatusProbe | None
submission_description: str
submission_status: str
submission_value: str | None
to_dict()[source]
Return type:

dict[str, object]

warnings: tuple[str, ...] = ()
class femic.bcdc_dwds.BcdcDwdsStatusProbe(order_id, raw_payload, status, description, value, download_url)[source]

Bases: object

One post-submission probe against the public DWDS order-status seam.

Parameters:

  • order_id (str)

  • raw_payload (dict[str, Any])

  • status (str | None)

  • description (str | None)

  • value (str | None)

  • download_url (str | None)

description: str | None
download_url: str | None
order_id: str
raw_payload: dict[str, Any]
status: str | None
to_dict()[source]
Return type:

dict[str, object]

value: str | None
femic.bcdc_dwds.follow_up_bcdc_dwds_order(order_result, *, download_root=None, poll_status=True)[source]

Re-probe a submitted DWDS order and materialize its artifact when ready.

Parameters:
Return type:

BcdcDwdsOrderResult

femic.bcdc_dwds.load_bcdc_dwds_manifest(path)[source]

Load one or more DWDS order results from a previously written manifest.

Parameters:

path (Path)

Return type:

list[BcdcDwdsOrderResult]

femic.bcdc_dwds.submit_bcdc_dwds_order(query, *, bbox_epsg3005, output_format='fgdb', limit=5, geomark=None, email_address=None, clip_to_aoi=True, poll_status=True, ordering_application='FEMIC-BCDC-DWDS')[source]

Submit a public DWDS order for the top-ranked BCDC package match.

Parameters:

  • query (str)

  • bbox_epsg3005 (tuple[float, float, float, float])

  • output_format (str)

  • limit (int)

  • geomark (GeomarkBBox | None)

  • email_address (str | None)

  • clip_to_aoi (bool)

  • poll_status (bool)

  • ordering_application (str)

Return type:

BcdcDwdsOrderResult

femic.bcdc_dwds.write_bcdc_dwds_manifest(results, path)[source]

Write one or more DWDS order results to a JSON manifest.

Parameters:
Return type:

Path