iplotx 0.2.0__tar.gz → 0.2.1__tar.gz

{iplotx-0.2.0 → iplotx-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iplotx
-Version: 0.2.0
+Version: 0.2.1
 Summary: Plot networkx from igraph and networkx.
 Project-URL: Homepage, https://github.com/fabilab/iplotx
 Project-URL: Documentation, https://readthedocs.org/iplotx
@@ -11,12 +11,20 @@ Author-email: Fabio Zanini <fabio.zanini@unsw.edu.au>
 Maintainer-email: Fabio Zanini <fabio.zanini@unsw.edu.au>
 License: MIT
 Keywords: graph,network,plotting,visualisation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: System :: Networking
+Classifier: Typing :: Typed
 Requires-Python: >=3.11
 Requires-Dist: matplotlib>=2.0.0
 Requires-Dist: numpy>=2.0.0
@@ -31,11 +39,12 @@ Description-Content-Type: text/markdown
 ![Github Actions](https://github.com/fabilab/iplotx/actions/workflows/test.yml/badge.svg)
 ![PyPI - Version](https://img.shields.io/pypi/v/iplotx)
 ![RTD](https://readthedocs.org/projects/iplotx/badge/?version=latest)
+![pylint](assets/pylint.svg)
 
 # iplotx
 Plotting networks from igraph and networkx.
 
-**NOTE**: This is currently alpha quality software. The API and functionality will break constantly, so use at your own risk. That said, if you have things you would like to see improved, please open a GitHub issue.
+**NOTE**: This is currently beta quality software. The API and functionality are settling in and might break occasionally.
 
 ## Installation
 ```bash
@@ -68,9 +77,12 @@ See [gallery](https://iplotx.readthedocs.io/en/latest/gallery/index.html).
 - Support storing the plot to disk thanks to the many matplotlib backends (SVG, PNG, PDF, etc.). ✅
 - Support flexible yet easy styling. ✅
 - Efficient plotting of large graphs using matplotlib's collection functionality. ✅
+- Support editing plotting elements after the plot is created, e.g. changing node colors, labels, etc. ✅
+- Support animations, e.g. showing the evolution of a network over time. ✅
 - Support trees from special libraries such as ete3, biopython, etc. This will need a dedicated function and layouting. ✅
-- Support animations, e.g. showing the evolution of a network over time. 🏗️
 - Support uni- and bi-directional communication between graph object and plot object.🏗️
 
+**NOTE:** The last item can probably be achieved already by using `matplotlib`'s existing callback functionality. It is currently untested, but if you manage to get it to work on your graph let me know and I'll add it to the examples (with credit).
+
 ## Authors
 Fabio Zanini (https://fabilab.org)

{iplotx-0.2.0 → iplotx-0.2.1}/README.md

@@ -1,11 +1,12 @@
 ![Github Actions](https://github.com/fabilab/iplotx/actions/workflows/test.yml/badge.svg)
 ![PyPI - Version](https://img.shields.io/pypi/v/iplotx)
 ![RTD](https://readthedocs.org/projects/iplotx/badge/?version=latest)
+![pylint](assets/pylint.svg)
 
 # iplotx
 Plotting networks from igraph and networkx.
 
-**NOTE**: This is currently alpha quality software. The API and functionality will break constantly, so use at your own risk. That said, if you have things you would like to see improved, please open a GitHub issue.
+**NOTE**: This is currently beta quality software. The API and functionality are settling in and might break occasionally.
 
 ## Installation
 ```bash
@@ -38,9 +39,12 @@ See [gallery](https://iplotx.readthedocs.io/en/latest/gallery/index.html).
 - Support storing the plot to disk thanks to the many matplotlib backends (SVG, PNG, PDF, etc.). ✅
 - Support flexible yet easy styling. ✅
 - Efficient plotting of large graphs using matplotlib's collection functionality. ✅
+- Support editing plotting elements after the plot is created, e.g. changing node colors, labels, etc. ✅
+- Support animations, e.g. showing the evolution of a network over time. ✅
 - Support trees from special libraries such as ete3, biopython, etc. This will need a dedicated function and layouting. ✅
-- Support animations, e.g. showing the evolution of a network over time. 🏗️
 - Support uni- and bi-directional communication between graph object and plot object.🏗️
 
+**NOTE:** The last item can probably be achieved already by using `matplotlib`'s existing callback functionality. It is currently untested, but if you manage to get it to work on your graph let me know and I'll add it to the examples (with credit).
+
 ## Authors
 Fabio Zanini (https://fabilab.org)

iplotx-0.2.1/assets/pylint.svg

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="80" height="20">
+    <linearGradient id="b" x2="0" y2="100%">
+        <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+        <stop offset="1" stop-opacity=".1"/>
+    </linearGradient>
+    <mask id="anybadge_1">
+        <rect width="80" height="20" rx="3" fill="#fff"/>
+    </mask>
+    <g mask="url(#anybadge_1)">
+        <path fill="#555" d="M0 0h44v20H0z"/>
+        <path fill="#4C1" d="M44 0h36v20H44z"/>
+        <path fill="url(#b)" d="M0 0h80v20H0z"/>
+    </g>
+    <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
+        <text x="23.0" y="15" fill="#010101" fill-opacity=".3">pylint</text>
+        <text x="22.0" y="14">pylint</text>
+    </g>
+    <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
+        <text x="63.0" y="15" fill="#010101" fill-opacity=".3">9.13</text>
+        <text x="62.0" y="14">9.13</text>
+    </g>
+</svg>

{iplotx-0.2.0 → iplotx-0.2.1}/docs/source/conf.py

@@ -49,6 +49,8 @@ myst_enable_extensions = ["colon_fence"]
 sphinx_gallery_conf = {
     "examples_dirs": "../../gallery",  # path to your example scripts
     "gallery_dirs": "./gallery",  # path to where to save gallery generated output
+    #'matplotlib_animations': (True, 'mp4'),
+    "matplotlib_animations": True,
 }
 
 source_suffix = {

{iplotx-0.2.0 → iplotx-0.2.1}/docs/source/sg_execution_times.rst

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:00.061** total execution time for 30 files **from all galleries**:
+**00:01.429** total execution time for 32 files **from all galleries**:
 
 .. container::
 
@@ -32,8 +32,8 @@ Computation times
    * - Example
      - Time
      - Mem (MB)
-   * - :ref:`sphx_glr_gallery_plot_ports.py` (``../../gallery/plot_ports.py``)
-     - 00:00.061
+   * - :ref:`sphx_glr_gallery_plot_animation.py` (``../../gallery/plot_animation.py``)
+     - 00:01.429
      - 0.0
    * - :ref:`sphx_glr_gallery_plot_basic.py` (``../../gallery/plot_basic.py``)
      - 00:00.000
@@ -65,6 +65,9 @@ Computation times
    * - :ref:`sphx_glr_gallery_plot_directed.py` (``../../gallery/plot_directed.py``)
      - 00:00.000
      - 0.0
+   * - :ref:`sphx_glr_gallery_plot_edit_artists.py` (``../../gallery/plot_edit_artists.py``)
+     - 00:00.000
+     - 0.0
    * - :ref:`sphx_glr_gallery_plot_ete4.py` (``../../gallery/plot_ete4.py``)
      - 00:00.000
      - 0.0
@@ -98,6 +101,9 @@ Computation times
    * - :ref:`sphx_glr_gallery_plot_parallel_igraph_networkx.py` (``../../gallery/plot_parallel_igraph_networkx.py``)
      - 00:00.000
      - 0.0
+   * - :ref:`sphx_glr_gallery_plot_ports.py` (``../../gallery/plot_ports.py``)
+     - 00:00.000
+     - 0.0
    * - :ref:`sphx_glr_gallery_plot_shortest_path.py` (``../../gallery/plot_shortest_path.py``)
      - 00:00.000
      - 0.0

iplotx-0.2.1/gallery/plot_animation.py

@@ -0,0 +1,61 @@
+"""
+Animations
+==========
+
+This tutorial shows how to animate `iplotx` visualizations using `matplotlib.animation.FuncAnimation`.
+
+For illustration purposes, we will animate a simple directed graph, rotating it around its center. We also modify the opacity of the vertices and edges, just for fun.
+"""
+
+import matplotlib.pyplot as plt
+import numpy as np
+import matplotlib.animation as animation
+import igraph as ig
+import iplotx as ipx
+
+g = ig.Graph.Ring(3, directed=True)
+layout = np.asarray(g.layout("circle").coords)
+
+# The animation will rotate the layout of the graph
+thetas = np.linspace(0, 2 * np.pi, 101)[:-1]
+
+fig, ax = plt.subplots()
+art = ipx.network(g, ax=ax, layout=layout, aspect=1)[0]
+ax.set(xlim=[-2, 2], ylim=[-2, 2])
+
+
+def rotate(vector, theta):
+    """Rotate a 2D vector by an angle theta (in radians) clockwise."""
+    return vector @ np.array(
+        [
+            [np.cos(theta), -np.sin(theta)],
+            [np.sin(theta), np.cos(theta)],
+        ],
+    )
+
+
+def update(frame):
+    # for each frame, update the vertex positions
+    theta = thetas[frame]
+
+    # The new layout is the old layout rotated by theta, clockwise
+    layout_new = rotate(layout, theta)
+
+    # Also change transparency, slower
+    alpha_vertices = 1 - np.abs(np.sin(theta / 2))
+    alpha_edges = 0.25 + 0.75 * np.abs(np.sin(theta / 2))
+
+    # Edit the vertices' positions
+    art.get_vertices().set_offsets(layout_new)
+    art.get_vertices().set_alpha(alpha_vertices)
+    art.get_edges().set_alpha(alpha_edges)
+    return (art.get_vertices(), art.get_edges())
+
+
+# Run the animation
+ani = animation.FuncAnimation(
+    fig=fig,
+    func=update,
+    frames=len(thetas),
+    interval=30,
+)

iplotx-0.2.1/gallery/plot_edit_artists.py

@@ -0,0 +1,59 @@
+"""
+Editing artists after plotting
+==============================
+
+One of the strengths of `iplotx` is the support for editing artists after they have been plotted the first time without making a whole new figure.
+
+In this example, we will change vertices, edges, arrows, etc. and check out how they look like.
+"""
+
+# %%
+# This is the vanilla version, taken from the "Ports" gallery example:
+
+import igraph as ig
+import numpy as np
+import matplotlib.pyplot as plt
+import iplotx as ipx
+
+g = ig.Graph.Ring(3, directed=True)
+
+artist = ipx.network(
+    g,
+    layout="circle",
+    edge_curved=True,
+    edge_ports=[
+        ("n", "w"),  # exit from the top, enter from the left
+        ("e", "s"),  # exit from the right, enter from the bottom
+        ("n", "s"),  # exit from the top, enter from the bottom
+    ],
+    edge_tension=[1.5, 1.8, 0.8],
+    edge_color=["tomato", "steelblue", "purple"],
+)[0]
+
+# %%
+# Now we can change the vertex sizes:
+
+# SAME BLOCK AS BEFORE, ONLY NEEDED TO MAKE A NEW FIGURE
+artist = ipx.network(
+    g,
+    layout="circle",
+    edge_curved=True,
+    edge_ports=[
+        ("n", "w"),  # exit from the top, enter from the left
+        ("e", "s"),  # exit from the right, enter from the bottom
+        ("n", "s"),  # exit from the top, enter from the bottom
+    ],
+    edge_tension=[1.5, 1.8, 0.8],
+    edge_color=["tomato", "steelblue", "purple"],
+)[0]
+# END OF SAME BLOCK
+
+artist.get_vertices().set_sizes([5, 5, 40])
+artist.get_edges().set_ports(
+    [
+        ("n", "n"),
+        ("w", None),
+        ("e", "s"),
+    ]
+)
+artist.get_edges().set_tension([1.3, 0.3, 0.5])