nrel.hive
latest
  • Quick Start
  • Example
  • Inputs
  • Outputs
  • Customize
  • Developer Docs
  • API Reference
    • nrel
      • Subpackages
        • nrel.hive
nrel.hive
  • API Reference
  • nrel
  • nrel.hive
  • nrel.hive.model
  • nrel.hive.model.roadnetwork
  • nrel.hive.model.roadnetwork.haversine_link_id_ops
  • Edit on GitHub

nrel.hive.model.roadnetwork.haversine_link_id_ops

Module Contents

Functions

geoids_to_link_id(→ nrel.hive.util.LinkId)

constructs a LinkId for HaversineRoadNetworks from two GeoIds

link_id_to_geodis(→ Tuple[nrel.hive.util.GeoId, ...)

unpacks the GeoIds encoded in a HaversineRoadNetwork LinkId

nrel.hive.model.roadnetwork.haversine_link_id_ops.geoids_to_link_id(origin: nrel.hive.util.GeoId, destination: nrel.hive.util.GeoId) → nrel.hive.util.LinkId[source]

constructs a LinkId for HaversineRoadNetworks from two GeoIds :param origin: the origin GeoId :param destination: the destination GeoId :return: a HaversineRoadNetwork LinkId

nrel.hive.model.roadnetwork.haversine_link_id_ops.link_id_to_geodis(link_id: nrel.hive.util.LinkId) → Tuple[nrel.hive.util.GeoId, nrel.hive.util.GeoId][source]

unpacks the GeoIds encoded in a HaversineRoadNetwork LinkId :param link_id: the LinkId to extract :return: the origin and destination GeoIds encoded in this LinkId :raises: TypeError, when the provided LinkId does not take the expected form

Previous Next

© Copyright 2022, NREL. Revision 224263b8.

Built with Sphinx using a theme provided by Read the Docs.