iplotx 0.0.1__tar.gz

iplotx-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

iplotx-0.0.1/.github/workflows/test.yml

@@ -0,0 +1,41 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install the project
+      run: uv sync --all-extras --group test
+
+    - name: Run pytest
+      run: uv run pytest tests
+
+    - name: Run flake8
+      run: uv run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

iplotx-0.0.1/.gitignore

@@ -0,0 +1,177 @@
+# Test images
+result_images
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

iplotx-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 fabilab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

iplotx-0.0.1/MANIFEST.in

@@ -0,0 +1,13 @@
+prune .git
+prune .github
+
+include iplotx
+include MANIFEST.in
+include tests/*.py
+
+graft doc
+prune doc/html
+prune doc/source/tutorials
+
+global-exclude .dockerignore .DS_Store .gitattributes .gitignore .gitmodules
+

iplotx-0.0.1/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: iplotx
+Version: 0.0.1
+Summary: Plot networkx from igraph and networkx.
+Project-URL: Homepage, https://github.com/fabilab/iplotx
+Project-URL: Documentation, https://readthedocs.org/iplotx
+Project-URL: Repository, https://github.com/fabilab/iplotx.git
+Project-URL: Bug Tracker, https://github.com/fabilab/iplotx/issues
+Project-URL: Changelog, https://github.com/fabilab/iplotx/blob/main/CHANGELOG.md
+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: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.10
+Requires-Dist: matplotlib>=2.0.0
+Requires-Dist: pandas>=2.0.0
+Provides-Extra: igraph
+Requires-Dist: igraph>=0.11.0; extra == 'igraph'
+Provides-Extra: networkx
+Requires-Dist: networkx>=2.0.0; extra == 'networkx'
+Description-Content-Type: text/markdown
+
+# iplotx
+Plotting networks from igraph and networkx.
+
+**NOTE**: This is currently pre-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.
+
+## Roadmap
+- Plot networks from igraph and networkx interchangeably, using matplotlib as a backend. ✅
+- Support interactive plotting, e.g. zooming and panning after the plot is created. ✅
+- Support storing the plot to disk thanks to the many matplotlib backends (SVG, PNG, PDF, etc.).
+- Efficient plotting of large graphs using matplotlib's collection functionality. ✅ (partially)
+- Support animations, e.g. showing the evolution of a network over time. 🏗️
+- Support uni- and bi-directional communication between graph object and plot object.🏗️
+
+## Authors
+Fabio Zanini (https://fabilab.org)

iplotx-0.0.1/README.md

@@ -0,0 +1,15 @@
+# iplotx
+Plotting networks from igraph and networkx.
+
+**NOTE**: This is currently pre-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.
+
+## Roadmap
+- Plot networks from igraph and networkx interchangeably, using matplotlib as a backend. ✅
+- Support interactive plotting, e.g. zooming and panning after the plot is created. ✅
+- Support storing the plot to disk thanks to the many matplotlib backends (SVG, PNG, PDF, etc.).
+- Efficient plotting of large graphs using matplotlib's collection functionality. ✅ (partially)
+- Support animations, e.g. showing the evolution of a network over time. 🏗️
+- Support uni- and bi-directional communication between graph object and plot object.🏗️
+
+## Authors
+Fabio Zanini (https://fabilab.org)

iplotx-0.0.1/iplotx/__init__.py

@@ -0,0 +1,2 @@
+from .version import __version__
+from .plotting import plot

iplotx-0.0.1/iplotx/edge/arrow.py

@@ -0,0 +1,122 @@
+import numpy as np
+import matplotlib as mpl
+from matplotlib.patches import PathPatch
+
+
+def make_arrow_patch(marker: str = "|>", width: float = 8, **kwargs):
+    """Make a patch of the given marker shape and size."""
+    height = kwargs.pop("height", width * 1.3)
+
+    if marker == "|>":
+        codes = ["MOVETO", "LINETO", "LINETO"]
+        path = mpl.path.Path(
+            np.array([[-height, width * 0.5], [-height, -width * 0.5], [0, 0]]),
+            codes=[getattr(mpl.path.Path, x) for x in codes],
+            closed=True,
+        )
+    elif marker == ">":
+        kwargs["facecolor"] = "none"
+        if "color" in kwargs:
+            kwargs["edgecolor"] = kwargs.pop("color")
+        codes = ["MOVETO", "LINETO", "LINETO"]
+        path = mpl.path.Path(
+            np.array([[-height, width * 0.5], [0, 0], [-height, -width * 0.5]]),
+            codes=[getattr(mpl.path.Path, x) for x in codes],
+            closed=False,
+        )
+    elif marker == ">>":
+        overhang = kwargs.pop("overhang", 0.25)
+        codes = ["MOVETO", "LINETO", "LINETO", "LINETO"]
+        path = mpl.path.Path(
+            np.array(
+                [
+                    [0, 0],
+                    [-height, -width * 0.5],
+                    [-height * (1.0 - overhang), 0],
+                    [-height, width * 0.5],
+                ]
+            ),
+            codes=[getattr(mpl.path.Path, x) for x in codes],
+            closed=True,
+        )
+    elif marker == ")>":
+        overhang = kwargs.pop("overhang", 0.25)
+        codes = ["MOVETO", "LINETO", "CURVE3", "CURVE3"]
+        path = mpl.path.Path(
+            np.array(
+                [
+                    [0, 0],
+                    [-height, -width * 0.5],
+                    [-height * (1.0 - overhang), 0],
+                    [-height, width * 0.5],
+                ]
+            ),
+            codes=[getattr(mpl.path.Path, x) for x in codes],
+            closed=True,
+        )
+    elif marker == ")":
+        kwargs["facecolor"] = "none"
+        if "color" in kwargs:
+            kwargs["edgecolor"] = kwargs.pop("color")
+        codes = ["MOVETO", "CURVE3", "CURVE3"]
+        path = mpl.path.Path(
+            np.array(
+                [
+                    [-height * 0.5, width * 0.5],
+                    [height * 0.5, 0],
+                    [-height * 0.5, -width * 0.5],
+                ]
+            ),
+            codes=[getattr(mpl.path.Path, x) for x in codes],
+            closed=False,
+        )
+    elif marker == "d":
+        codes = ["MOVETO", "LINETO", "LINETO", "LINETO"]
+        path = mpl.path.Path(
+            np.array(
+                [
+                    [-height * 0.5, width * 0.5],
+                    [-height, 0],
+                    [-height * 0.5, -width * 0.5],
+                    [0, 0],
+                ]
+            ),
+            codes=[getattr(mpl.path.Path, x) for x in codes],
+            closed=True,
+        )
+    elif marker == "p":
+        codes = ["MOVETO", "LINETO", "LINETO", "LINETO"]
+        path = mpl.path.Path(
+            np.array(
+                [
+                    [-height, 0],
+                    [0, 0],
+                    [0, -width],
+                    [-height, -width],
+                ]
+            ),
+            codes=[getattr(mpl.path.Path, x) for x in codes],
+            closed=True,
+        )
+    elif marker == "q":
+        codes = ["MOVETO", "LINETO", "LINETO", "LINETO"]
+        path = mpl.path.Path(
+            np.array(
+                [
+                    [-height, 0],
+                    [0, 0],
+                    [0, width],
+                    [-height, width],
+                ]
+            ),
+            codes=[getattr(mpl.path.Path, x) for x in codes],
+            closed=True,
+        )
+
+    patch = PathPatch(
+        path,
+        **kwargs,
+    )
+    return patch
+
+    raise KeyError(f"Unknown marker: {marker}")

iplotx-0.0.1/iplotx/edge/common.py

@@ -0,0 +1,47 @@
+from math import pi
+import numpy as np
+
+
+def _compute_loops_per_angle(nloops, angles):
+    if len(angles) == 0:
+        return [(0, 2 * pi, nloops)]
+
+    angles_sorted_closed = list(sorted(angles))
+    angles_sorted_closed.append(angles_sorted_closed[0] + 2 * pi)
+    deltas = np.diff(angles_sorted_closed)
+
+    # Now we have the deltas and the total number of loops
+    # 1. Assign all loops to the largest wedge
+    idx_dmax = deltas.argmax()
+    if nloops == 1:
+        return [
+            (angles_sorted_closed[idx_dmax], angles_sorted_closed[idx_dmax + 1], nloops)
+        ]
+
+    # 2. Check if any other wedges are larger than this
+    # If not, we are done (this is the algo in igraph)
+    dsplit = deltas[idx_dmax] / nloops
+    if (deltas > dsplit).sum() < 2:
+        return [
+            (angles_sorted_closed[idx_dmax], angles_sorted_closed[idx_dmax + 1], nloops)
+        ]
+
+    # 3. Check how small the second-largest wedge would become
+    idx_dsort = np.argsort(deltas)
+    return [
+        (
+            angles_sorted_closed[idx_dmax],
+            angles_sorted_closed[idx_dmax + 1],
+            nloops - 1,
+        ),
+        (
+            angles_sorted_closed[idx_dsort[-2]],
+            angles_sorted_closed[idx_dsort[-2] + 1],
+            1,
+        ),
+    ]
+
+    ## TODO: we should greedily iterate from this
+    ## TODO: finish this
+    # dsplit_new = dsplit * nloops / (nloops - 1)
+    # dsplit2_new = deltas[idx_dsort[-2]]