hiveplotlib 0.22.0__tar.gz → 0.23.0__tar.gz

{hiveplotlib-0.22.0/src/hiveplotlib.egg-info → hiveplotlib-0.23.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hiveplotlib
-Version: 0.22.0
+Version: 0.23.0
 Summary: Visualize Network Data with Hive Plots
 Author-email: Gary Koplik <gary.koplik@geomdata.com>
 License: Copyright (c) 2020 - 2023, Geometric Data Analytics, Inc.
@@ -57,6 +57,8 @@ Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Requires-Dist: toml; extra == "docs"
 Provides-Extra: networkx
 Requires-Dist: networkx; extra == "networkx"
+Provides-Extra: plotly
+Requires-Dist: plotly; extra == "plotly"
 Provides-Extra: testing
 Requires-Dist: black[jupyter]; extra == "testing"
 Requires-Dist: flake8-docstrings; extra == "testing"

{hiveplotlib-0.22.0 → hiveplotlib-0.23.0}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hiveplotlib"
-version = "0.22.0"
+version = "0.23.0"
 authors = [
     {name="Gary Koplik", email="gary.koplik@geomdata.com"}
 ]
@@ -54,6 +54,10 @@ networkx = [
     "networkx"
 ]
 
+plotly = [
+    "plotly"
+]
+
 testing = [
     "black[jupyter]",
     "flake8-docstrings",
@@ -85,10 +89,9 @@ exclude = [
 extend_ignore = [
     "D200",  # 1-line docstrings will be tolerated
     "E203",  # https://black.readthedocs.io/en/stable/faq.html#why-are-flake8-s-e203-and-w503-violated
-    "E501",  # can't check line-length and have long hyperlinks in the docs
     "W503"  # docs literally say this should not be a thing https://www.flake8rules.com/rules/W504.html
 ]
-# skipping any line length checks because of long hyperlink docstring lines.
-color = "always"
+# keeping a longer-allowed line-length on flake8 side for existing docs
+max-line-length = 120
 show-source = true
 count = true

{hiveplotlib-0.22.0 → hiveplotlib-0.23.0}/src/hiveplotlib/datasets/__init__.py

@@ -147,7 +147,10 @@ def four_gaussian_blobs_3d(
 
 
 def example_hive_plot(
-    num_nodes: int = 15, num_edges: int = 30, seed: int = 0
+    num_nodes: int = 15,
+    num_edges: int = 30,
+    seed: int = 0,
+    **hive_plot_n_axes_kwargs,
 ) -> HivePlot:
     """
     Generate example hive plot with ``"Low"``, ``"Medium"``, and ``"High"`` axes (plus repeat axes).
@@ -157,6 +160,8 @@ def example_hive_plot(
     :param num_nodes: number of nodes to generate.
     :param num_edges: number of edges to generate.
     :param seed: random seed to use when generating nodes and edges.
+    :param hive_plot_n_axes_kwargs: additional keyword arguments for the underlying
+        :py:func:`hiveplotlib.hive_plot.hive_plot_n_axes()` call.
     :return: resulting ``HivePlot`` instance.
     """
     color_dict = {
@@ -202,7 +207,7 @@ def example_hive_plot(
         repeat_axes=[True, True, True],
         axes_names=["Low", "Medium", "High"],
         orient_angle=-30,
-        all_edge_kwargs=dict(alpha=1),
+        **hive_plot_n_axes_kwargs,
     )
 
     # set colors according to above-defined color dictionary

{hiveplotlib-0.22.0 → hiveplotlib-0.23.0}/src/hiveplotlib/hiveplot.py

@@ -52,6 +52,9 @@ class HivePlot:
         # maintain dictionary of dictionaries of dictionaries of edge information
         self.edges = dict()
 
+        # maintain the largest polar end point from the axes (for plotting)
+        self.max_polar_end = None
+
     def add_axes(self, axes: List[Axis]):
         """
         Add list of ``Axis`` instances to ``HivePlot.axes``.
@@ -72,6 +75,10 @@ class HivePlot:
         for axis in axes:
             self.axes[axis.axis_id] = axis
             self.node_assignments[axis.axis_id] = None
+
+        # update overall largest max polar end point
+        self.max_polar_end = max([axis.polar_end for axis in self.axes.values()])
+
         return None
 
     def add_nodes(self, nodes: List[Node], check_uniqueness: bool = True):

{hiveplotlib-0.22.0 → hiveplotlib-0.23.0}/src/hiveplotlib/utils.py

@@ -59,9 +59,7 @@ def bezier(
     :return: ``(num_steps, )`` sized ``np.ndarray`` of 1-dimensional discretized Bézier curve output.
     """
     steps = np.linspace(0, 1, num_steps)
-    return (
-        (1 - steps) ** 2 * start + 2 * (1 - steps) * steps * control + steps**2 * end
-    )
+    return (1 - steps) ** 2 * start + 2 * (1 - steps) * steps * control + steps**2 * end
 
 
 def bezier_all(
@@ -94,6 +92,4 @@ def bezier_all(
     end = np.repeat(end_arr, num_steps)
     control = np.repeat(control_arr, num_steps)
 
-    return (
-        (1 - steps) ** 2 * start + 2 * (1 - steps) * steps * control + steps**2 * end
-    )
+    return (1 - steps) ** 2 * start + 2 * (1 - steps) * steps * control + steps**2 * end

hiveplotlib-0.23.0/src/hiveplotlib/viz/base.py

@@ -0,0 +1,61 @@
+# base.py
+
+"""
+Base (viz back-end-agnostic) functionality for visualizations in ``hiveplotlib``.
+"""
+
+from hiveplotlib import Axis
+from typing import Literal, Tuple
+
+
+def get_axis_label_alignment(
+    axis: Axis,
+    backend: Literal = ["matplotlib", "bokeh", "plotly"],
+    horizontal_angle_span: float = 60,
+    vertical_angle_span: float = 60,
+) -> Tuple[Literal["bottom", "middle", "top"], Literal["left", "center", "right"]]:
+    """
+    Generate appropriate horizontal and vertical alignment for text at the radial end point of an ``Axis`` instance.
+
+    ``horizontal_angle_span`` and ``vertical_angle_span`` dictate the text alignment partition, measured in degrees. See
+    the below parameter descriptions for how each value is used to partition the angle space.
+
+    :param axis: ``Axis`` for which to generate the appropriate text alignment.
+    :param backend: which plotting back end to use. (Different back ends have different string names for their
+        alignment options.)
+    :param horizontal_angle_span: ``[-horizontal_angle_span, horizontal_angle_span]`` will be ``"left"`` aligned.
+        ``[180 - horizontal_angle_span, 180 + horizontal_angle_span]`` will be ``right`` aligned, and all other angles
+        will be ``"center"`` aligned.
+    :param vertical_angle_span: ``[90 - vertical_angle_span, 90 + vertical_angle_span]`` will be ``"bottom"`` aligned.
+        ``[270 - vertical_angle_span, 270 + vertical_angle_span]`` will be ``top`` aligned, and all other angles
+        will be ``"middle"`` aligned.
+    :return: vertical alignment string and horizontal alignment string appropriate for the edge of the provided
+        ``Axis`` instance.
+    """
+    horizontal_alignment_dict = dict(left="left", center="center", right="right")
+    vertical_alignment_dict = dict(bottom="bottom", middle="middle", top="top")
+
+    # matplotlib has different naming convention than default
+    if backend == "matplotlib":
+        vertical_alignment_dict["middle"] = "center"
+
+    # range in each direction from 0, 180 to specify horizontal alignment
+    if (
+        axis.angle >= 360 - horizontal_angle_span
+        or axis.angle <= 0 + horizontal_angle_span
+    ):
+        horizontalalignment = horizontal_alignment_dict["left"]
+    elif 180 + horizontal_angle_span >= axis.angle >= 180 - horizontal_angle_span:
+        horizontalalignment = horizontal_alignment_dict["right"]
+    else:
+        horizontalalignment = horizontal_alignment_dict["center"]
+
+    # range in each direction from 90, 270 to specify vertical alignment
+    if 90 + vertical_angle_span >= axis.angle >= 90 - vertical_angle_span:
+        verticalalignment = vertical_alignment_dict["bottom"]
+    elif 270 - vertical_angle_span <= axis.angle <= 270 + vertical_angle_span:
+        verticalalignment = vertical_alignment_dict["top"]
+    else:
+        verticalalignment = vertical_alignment_dict["middle"]
+
+    return verticalalignment, horizontalalignment