iplotx 1.4.0__tar.gz → 1.4.2__tar.gz

{iplotx-1.4.0 → iplotx-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iplotx
-Version: 1.4.0
+Version: 1.4.2
 Summary: Plot networkx from igraph and networkx.
 Project-URL: Homepage, https://github.com/fabilab/iplotx
 Project-URL: Documentation, https://readthedocs.org/iplotx

{iplotx-1.4.0 → iplotx-1.4.2}/docs/source/installing.md

@@ -11,13 +11,11 @@ pip install iplotx
 
 ```
 import igraph as ig
-import matplotlib.pyplot as plt
 import iplotx as ipx
 
 g = ig.Graph.Ring(5)
 layout = g.layout("circle").coords
-fig, ax = plt.subplots(figsize=(3, 3))
-ipx.plot(g, ax=ax, layout=layout)
+ipx.network(g, layout)
 ```
 
 
@@ -27,13 +25,11 @@ ipx.plot(g, ax=ax, layout=layout)
 :::{tab-item} networkx
 ```
 import networkx as nx
-import matplotlib.pyplot as plt
 import iplotx as ipx
 
 g = nx.Graph([(0, 1), (1, 2), (2, 3), (3, 4), (4, 0)])
 layout = nx.layout.circular_layout(g)
-fig, ax = plt.subplots(figsize=(3, 3))
-ipx.plot(g, ax=ax, layout=layout)
+ipx.network(g, layout)
 ```
 
 :::
@@ -44,9 +40,6 @@ Either way, the result is the same:
 
 ![graph_basic](_static/graph_basic.png)
 
-## Gallery
-See <project:gallery/index.rst> for examples of plots made with `iplotx`. Feel free to suggest new examples on GitHub by opening a new issue or pull request!
-
 ## Features
 `iplotx`'s features' include:
 - per-edge and per-vertex styling using sequences or dictionaries
@@ -72,32 +65,17 @@ See <project:gallery/index.rst> for examples of plots made with `iplotx`. Feel f
 - animations (see <project:gallery/other/plot_animation.rst>)
 - 3D visualisations
 - mouse/keyboard interaction and events (e.g. hover, click, see <project:gallery/other/plot_mouse_hover.rst>)
-- ... and probably more by the time you read this.
+- ... and many more.
 
-## Styles
-`iplotx` is designed to produce publication-quality figures using **styles**, which are dictionaries specifying the visual properties of each graph element, including vertices, edges, arrows, labels, and groupings.
+## Rationale
+We believe graph **analysis**, graph **layouting**, and graph **visualisation** to be three separate tasks. `iplotx` currently focuses on visualisation. It can also compute simple tree layouts and might expand towards network layouts in the future.
 
-An example of style specification is as follows:
+## Citation
+If you use `iplotx` for publication figures, please cite the [zenodo preprint](https://doi.org/10.5281/zenodo.16599333):
 
-```python
-import iplotx as ipx
-with ipx.style.context({
-    'vertex': {
-        'size': 30,
-        'facecolor': 'red',
-        'edgecolor': 'none',
-    }
-}):
-    ipx.plot(...)
 ```
-
-See <project:style.md> for more info.
-
-## Reference API
-See <project:api.md> for reference documentation of all functions and classes in `iplotx`.
-
-## Rationale
-We believe graph **analysis**, graph **layouting**, and graph **visualisation** to be three separate tasks. `iplotx` currently focuses on visualisation. It can also compute simple tree layouts and might expand towards network layouts in the future.
+F. Zanini. (2025). Unified network visualisation in Python. Zenodo [PREPRINT]. https://doi.org/10.5281/zenodo.16599333
+```
 
 ## Contributing
 Open an [issue on GitHub](https://github.com/fabilab/iplotx/issues) to request features, report bugs, or show intention in contributing. Pull requests are very welcome.

{iplotx-1.4.0 → iplotx-1.4.2}/docs/source/sg_execution_times.rst

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:00.117** total execution time for 79 files **from all galleries**:
+**00:00.092** total execution time for 82 files **from all galleries**:
 
 .. container::
 
@@ -32,12 +32,18 @@ Computation times
    * - Example
      - Time
      - Mem (MB)
-   * - :ref:`sphx_glr_gallery_basic_plot_arcs.py` (``../../gallery/basic/plot_arcs.py``)
-     - 00:00.117
+   * - :ref:`sphx_glr_gallery_other_plot_multiarc.py` (``../../gallery/other/plot_multiarc.py``)
+     - 00:00.060
+     - 0.0
+   * - :ref:`sphx_glr_gallery_other_plot_filled_edges.py` (``../../gallery/other/plot_filled_edges.py``)
+     - 00:00.032
      - 0.0
    * - :ref:`sphx_glr_gallery_basic_plot_3d.py` (``../../gallery/basic/plot_3d.py``)
      - 00:00.000
      - 0.0
+   * - :ref:`sphx_glr_gallery_basic_plot_arcs.py` (``../../gallery/basic/plot_arcs.py``)
+     - 00:00.000
+     - 0.0
    * - :ref:`sphx_glr_gallery_basic_plot_basic.py` (``../../gallery/basic/plot_basic.py``)
      - 00:00.000
      - 0.0
@@ -170,6 +176,9 @@ Computation times
    * - :ref:`sphx_glr_gallery_style_plot_depthshade.py` (``../../gallery/style/plot_depthshade.py``)
      - 00:00.000
      - 0.0
+   * - :ref:`sphx_glr_gallery_style_plot_edge_geometries.py` (``../../gallery/style/plot_edge_geometries.py``)
+     - 00:00.000
+     - 0.0
    * - :ref:`sphx_glr_gallery_style_plot_edgepadding.py` (``../../gallery/style/plot_edgepadding.py``)
      - 00:00.000
      - 0.0

{iplotx-1.4.0 → iplotx-1.4.2}/gallery/basic/plot_arcs.py

@@ -23,11 +23,8 @@ ipx.plot(
 )
 
 # %%
-# ..tip::
-#   Specifically, tension is defined as the tangent of the quarter of the angle spanned by the arc. A tension of 0 gives
-#   a straight line, a tension of 1 gives a semicircle, and higher tensions give increasingly larger arcs. A tension of
-#   infinity would give you a straight line away from the target vertex, but is not accepted by the library. Negative
-#   tensions result in arcs curving in the opposite direction.
+#
+# Other values of tension can be used to create different arc shapes:
 
 fig, axs = plt.subplots(2, 2, figsize=(8, 8))
 for tension, ax in zip([0.5, 2.5, -0.5, -2.5], axs.ravel()):
@@ -40,3 +37,11 @@ for tension, ax in zip([0.5, 2.5, -0.5, -2.5], axs.ravel()):
         margins=0.15,
         title=f"Edge tension = {tension:.2f}",
     )
+
+# %%
+# .. tip::
+#  Tension is defined as the tangent of the quarter of the angle spanned by the arc. A tension of 0 gives
+#  a straight line, a tension of 1 gives a semicircle, and higher tensions give increasingly larger arcs. A tension of
+#  infinity would give you a straight line away from the target vertex, but is not accepted by the library. Negative
+#  tensions result in arcs curving in the opposite direction.
+#

iplotx-1.4.2/gallery/other/plot_filled_edges.py

@@ -0,0 +1,36 @@
+"""
+Filled edges
+============
+
+Most of the time edges have no "filling", but what if they did? Then you would
+get this crazy example.
+
+.. tip::
+  Edges are not supposed to be filled, use at your own risk!
+"""
+
+import networkx as nx
+import matplotlib.pyplot as plt
+import iplotx as ipx
+
+g = nx.Graph()
+g.add_edges_from([(0, 1), (1, 2), (0, 2)])
+
+layout = [(0, 0), (1, 0), (2, 0)]
+
+artist = ipx.network(
+    g,
+    layout,
+    edge_arc=True,
+    edge_tension=-1,
+    vertex_facecolor="#005F73",
+    vertex_edgecolor="#001219",
+    vertex_linewidth=2,
+)[0]
+
+edge_artist = artist.get_edges()
+edge_artist.set_facecolors([
+    "#94D2BD66",
+    "#EE9B0066",
+    "#AE201266",
+])

iplotx-1.4.2/gallery/other/plot_multiarc.py

@@ -0,0 +1,24 @@
+"""
+Multiarc
+========
+
+This example shows how to plot a bunch of arcs.
+"""
+
+import igraph as ig
+import matplotlib.pyplot as plt
+import iplotx as ipx
+
+g = ig.Graph.Ring(4, directed=True)
+layout = [[1, 0], [0, 1], [-1, 0], [0, -1]]
+
+ipx.network(
+    g,
+    layout,
+    vertex_labels=True,
+    aspect=1,
+    edge_tension=1,
+    edge_arc=True,
+    edge_arrow={"marker": ">","width": 6},
+    edge_linewidth=3,
+)

iplotx-1.4.2/gallery/style/plot_edge_geometries.py

@@ -0,0 +1,61 @@
+"""
+Edge geometries
+===============
+
+This example shows how to use edge geometries and tension to achieve different visualisation styles.
+"""
+
+
+import igraph as ig
+import matplotlib.pyplot as plt
+import iplotx as ipx
+
+
+g = ig.Graph.Full(2)
+layout = [[0, 0], [1, 0]]
+
+fig, axs = plt.subplots(3, 3, figsize=(6, 6), sharex=True, sharey=True)
+tensions = [
+    [1, 5, 10],
+    [0.2, 1, 2],
+]
+for edge_arc, axrow, tensionrow in zip([False, True], axs, tensions):
+    kwargs = {}
+    if not edge_arc:
+        kwargs["edge_curved"] = True
+    for tension, ax in zip(tensionrow, axrow):
+        ipx.plot(
+            g,
+            layout=layout,
+            ax=ax,
+            edge_arc=edge_arc,
+            edge_tension=tension,
+            title=f"Tension {tension:.1f}",
+            node_size=10,
+            **kwargs,
+        )
+axs[0, 0].set_ylabel("Bezier", fontsize=12)
+axs[1, 0].set_ylabel("Arc", fontsize=12)
+ipx.plot(
+    g,
+    layout,
+    ax=axs[2, 0],
+    node_size=10,
+)
+axs[2, 0].set_ylabel("Straight", fontsize=12)
+ipx.plot(
+    g,
+    layout,
+    ax=axs[2, 1],
+    node_size=10,
+    edge_waypoints=[[0.5, -0.15]],
+)
+ipx.plot(
+    g,
+    layout,
+    ax=axs[2, 2],
+    node_size=10,
+    edge_waypoints=[[[0.25, -0.15], [0.75, -0.15]]],
+)
+axs[2, 1].set_ylabel("Waypoints", fontsize=12)
+fig.tight_layout()

{iplotx-1.4.0 → iplotx-1.4.2}/iplotx/edge/__init__.py

@@ -453,7 +453,7 @@ class EdgeCollection(mpl.collections.PatchCollection):
         # If none found, empty the dictionary already
         if (len(parallel_edges) == 0) or (max(parallel_edges.values(), key=len) == 1):
             parallel_edges = {}
-        if not self._style.get("curved", False):
+        if (not self._style.get("curved", False)) and (not self._style.get("arc", False)):
             while len(parallel_edges) > 0:
                 (v1, v2), indices = parallel_edges.popitem()
                 indices_inv = parallel_edges.pop((v2, v1), [])

{iplotx-1.4.0 → iplotx-1.4.2}/iplotx/edge/geometry.py

@@ -466,15 +466,17 @@ def _compute_edge_path_arc(
             )
         angle_start = atan2(*(vs[0] - center)[::-1])
         angle_end = atan2(*(vs[1] - center)[::-1])
-        if (np.abs(tension) > 1) and (np.abs(angle_end - angle_start) < np.pi):
-            if angle_end > angle_start:
-                angle_start += 2 * np.pi
-            else:
-                angle_end += 2 * np.pi
+
+        # Figure out how to draw the correct arc of the two
+        if (tension > 0) and (angle_end < angle_start):
+            angle_end += 2 * np.pi
+        elif (tension < 0) and (angle_end > angle_start):
+            angle_start += 2 * np.pi
+
         # print(f"angle_start: {np.degrees(angle_start):.2f}")
         # print(f"angle_end: {np.degrees(angle_end):.2f}")
 
-        naux = 30
+        naux = max(30, int(np.ceil(np.degrees(np.abs(angle_end - angle_start)))) // 3)
         angles = np.linspace(angle_start, angle_end, naux + 2)[1:-1]
         auxs = center + np.array([np.cos(angles), np.sin(angles)]).T * np.linalg.norm(
             vs[0] - center

{iplotx-1.4.0 → iplotx-1.4.2}/iplotx/version.py

@@ -2,4 +2,4 @@
 iplotx version information module.
 """
 
-__version__ = "1.4.0"
+__version__ = "1.4.2"

{iplotx-1.4.0 → iplotx-1.4.2}/tests/test_igraph.py

@@ -233,6 +233,36 @@ class GraphTestRunner(unittest.TestCase):
             margins=0.2,
         )
 
+    @image_comparison(baseline_images=["directed_arcs"])
+    def test_directed_arcs(self):
+        g = ig.Graph.Full(4, directed=True)
+        layout = [[0, 0], [1, 0], [2, 0], [3, 0]]
+
+        fig, ax = plt.subplots()
+        ipx.graph(
+            g,
+            layout=layout,
+            ax=ax,
+            edge_arc=True,
+            edge_tension=-3,
+            margins=0.2,
+        )
+
+    @image_comparison(baseline_images=["multiarc45"])
+    def test_multiarc(self):
+        g = ig.Graph.Ring(4, directed=True)
+        layout = [[1, 0], [0, 1], [-1, 0], [0, -1]]
+
+        fig, ax = plt.subplots()
+        ipx.graph(
+            g,
+            layout,
+            ax=ax,
+            edge_arc=True,
+            edge_tension=1,
+            aspect=1,
+        )
+
 
 class ClusteringTestRunner(unittest.TestCase):
     @property