topolib 0.0.0__py3-none-any.whl

topolib/visualization/mapview.py

@@ -0,0 +1,75 @@
+"""
+MapView class for visualizing network topologies.
+
+This module provides visualization methods for Topology objects.
+"""
+
+from typing import Any
+from topolib.topology import Topology
+import matplotlib.pyplot as plt
+import contextily as ctx
+import geopandas as gpd
+from shapely.geometry import Point
+
+
+class MapView:
+    """
+    Provides visualization methods for Topology objects.
+    """
+
+    def __init__(self, topology: Topology) -> None:
+        """
+        Initialize MapView with a Topology object.
+        :param topology: Topology object
+        """
+        self.topology = topology
+
+    def show_map(self) -> None:
+        """
+        Show all nodes and links of the topology on an OpenStreetMap base using contextily and Matplotlib.
+        The figure and plot title will be the topology name if available.
+        """
+        lons: list[float] = [node.longitude for node in self.topology.nodes]
+        lats: list[float] = [node.latitude for node in self.topology.nodes]
+        names: list[str] = [node.name for node in self.topology.nodes]
+        gdf: gpd.GeoDataFrame = gpd.GeoDataFrame(
+            {"name": names},
+            geometry=[Point(x, y) for x, y in zip(lons, lats)],
+            crs="EPSG:4326",
+        )
+        gdf = gdf.to_crs(epsg=3857)
+
+        # Map node id to projected coordinates
+        node_id_to_xy = {
+            node.id: (pt.x, pt.y) for node, pt in zip(self.topology.nodes, gdf.geometry)
+        }
+
+        # Try to get topology name (from attribute or fallback)
+        topo_name = getattr(self.topology, "name", None)
+        if topo_name is None:
+            # Try to get from dict if loaded from JSON
+            topo_name = getattr(self.topology, "_name", None)
+        if topo_name is None:
+            topo_name = "Topology"
+
+        fig, ax = plt.subplots(figsize=(10, 7))
+        fig.suptitle(topo_name, fontsize=16)
+        # Draw links as simple lines
+        for link in getattr(self.topology, "links", []):
+            src_id = getattr(link, "source").id
+            tgt_id = getattr(link, "target").id
+            if src_id in node_id_to_xy and tgt_id in node_id_to_xy:
+                x0, y0 = node_id_to_xy[src_id]
+                x1, y1 = node_id_to_xy[tgt_id]
+                ax.plot(
+                    [x0, x1], [y0, y1], color="gray", linewidth=1, alpha=0.7, zorder=2
+                )
+        # Draw nodes
+        gdf.plot(ax=ax, color="blue", markersize=40, zorder=5)
+        for x, y, name in zip(gdf.geometry.x, gdf.geometry.y, gdf["name"]):
+            ax.text(x, y, name, fontsize=8, ha="right", va="bottom", color="black")
+        ctx.add_basemap(ax, source=ctx.providers.OpenStreetMap.Mapnik)
+        ax.set_axis_off()
+        ax.set_title(f"Nodes and links ({topo_name})")
+        plt.tight_layout()
+        plt.show()

topolib-0.0.0.dist-info/METADATA

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: topolib
+Version: 0.0.0
+Summary: A compact Python library for modeling, analyzing, and visualizing optical network topologies.
+Author-email: Danilo Bórquez-Paredes <danilo.borquez.p@uai.cl>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/DaniloBorquez/topolib
+Project-URL: Documentation, https://topolib.readthedocs.io/
+Project-URL: Source, https://gitlab.com/DaniloBorquez/topolib
+Project-URL: Issues, https://gitlab.com/DaniloBorquez/topolib/-/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.21
+Requires-Dist: networkx>=2.6
+Dynamic: license-file
+
+# Topolib 🚀
+
+
+[![Python Version](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/)
+[![License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](LICENSE)
+[![Issues](https://img.shields.io/badge/issues-on%20GitLab-blue.svg)](https://gitlab.com/DaniloBorquez/topolib/-/issues)
+[![Develop coverage](https://gitlab.com/DaniloBorquez/topolib/badges/develop/coverage.svg)](https://gitlab.com/DaniloBorquez/topolib/-/pipelines?ref=develop)
+[![Release coverage](https://gitlab.com/DaniloBorquez/topolib/badges/release/coverage.svg)](https://gitlab.com/DaniloBorquez/topolib/-/pipelines?ref=release)
+[![Documentation Status](https://readthedocs.org/projects/topolib/badge/?version=latest)](https://topolib.readthedocs.io/en/latest/?badge=latest)
+
+A compact Python library for working with optical network topologies: nodes, links, metrics and visualization tools. 🌐
+
+## Overview
+
+Topolib models network topologies with three main modules:
+
+- `topolib.elements` — Definitions of elementary building blocks
+  - `Node` — represents a network node with id, name and geographic coordinates
+  - `Link` — connects two `Node` objects and stores link length and id
+
+- `topolib.topology` — High-level topology model
+  - `Topology` — holds nodes and links, provides methods to add/remove nodes and links, compute metrics, export JSON, and compute shortest/disjoint paths
+  - `Path` — represents a path through the topology
+
+- `topolib.analysis` — Metrics and analysis helpers
+  - `Metrics` — functions to compute node degree, link length statistics, connection matrices, etc.
+
+- `topolib.visualization` — Visualization helpers
+  - `MapView` — functions to display topology with OSM or paper-style maps
+
+(These components are derived from the project's class diagram in `diagrams/class_diagram.puml`.)
+
+## Features
+- Modular design: elements, topology, analysis, and visualization
+- Easy-to-use classes for nodes, links, and paths
+- Built-in metrics and analysis helpers
+- JSON import/export and interoperability
+- Ready for Sphinx, Read the Docs, and PyPI
+
+## Quickstart ⚡
+
+Create and activate a virtual environment, install dev dependencies and run tests:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -U pip
+python -m pip install -r dev-requirements.txt
+python -m pytest -q
+```
+
+## Installation
+
+```bash
+pip install topolib
+```
+
+Or for development:
+
+```bash
+git clone https://gitlab.com/DaniloBorquez/topolib.git
+cd topolib
+python -m venv .venv
+source .venv/bin/activate
+pip install -e .
+pip install -r dev-requirements.txt
+```
+
+## Documentation
+
+Full documentation: [https://topolib.readthedocs.io/](https://topolib.readthedocs.io/)
+
+## Basic usage example
+
+```py
+from topolib.elements.node import Node
+from topolib.topology.topology import Topology
+
+# Create nodes
+n1 = Node(1, 'A', 10.0, 20.0)
+n2 = Node(2, 'B', 11.0, 21.0)
+
+# Build topology
+topo = Topology()
+topo.add_node(n1)
+topo.add_node(n2)
+# add links, compute metrics, visualize
+```
+
+
+## Development 🛠️
+
+See `CONTRIBUTING.md` for development guidelines, commit message rules and pre-commit setup.
+
+
+
+## Class diagram
+
+![](diagrams/class_diagram.puml)
+
+(If you prefer a rendered image of the UML, render the PlantUML file locally or in your CI pipeline.)
+
+## License
+
+See `LICENSE` in the project root.

topolib-0.0.0.dist-info/RECORD

@@ -0,0 +1,38 @@
+diagrams/class_diagram.puml,sha256=4EUNpMrbHJYJ8wDM4DqtlIrJDTrvoyIeIiUdOoPsWlM,2183
+docs/Makefile,sha256=4zv3TVkTACm6JBaKgTES3ZI9cETXgM6ULbZkXZP1as8,638
+docs/requirements.txt,sha256=JBlj0kqsxcteWZpXAEKCobzqG-piWPAfj3_Bx46i9-c,24
+docs/source/conf.py,sha256=YeakUjMbnzKQov9CjOiFPmL4mOQ2JP2aHa4No55OYB4,1170
+docs/source/index.rst,sha256=ZFCeE5lH5ijU_oVfhGCYe5pq7ko_C1PhML0UHeKVXsg,1171
+docs/source/modules.rst,sha256=kRhINzEdye-kWHfUkCy6NByB3oT6FpEcCDWOscakUAA,58
+docs/source/topolib.analysis.rst,sha256=1NFOxh0O6ebf19ruvCcb9Oile2uzm_hWkKSb0RufT90,355
+docs/source/topolib.elements.rst,sha256=vk_Q_frmUk69gfxOx-_1VNdl7x3tLvc-QAIF4Wxo7wI,379
+docs/source/topolib.rst,sha256=J1kJ07JXz0yVyChjPofjTkP02Ns1fM96k9QX3HJCVVs,260
+docs/source/topolib.topology.rst,sha256=rdJH23kxZuGtB6rFISAWKUfEFGp5mZS1zRQ4zgwDRSc,510
+examples/show_topology_in_map.py,sha256=xjgLiSBHZJ8KYeaCdOBkwAAEJk4hSDkCxBvKNW7Ll9U,441
+tests/__init__.py,sha256=eAUS1VPZN5alBWqBdLK4sDxjRPxCvviXncxNvztzVGU,59
+tests/test_link.py,sha256=TEfNEivuE17OMmVP4YSi2-8-Mh9_2RDUXBG6Ds3Ljuc,1960
+tests/test_mapview.py,sha256=oOx_mYBSy95cacv4PfknP1N5VJzFTEoprhKLovU35Yo,977
+tests/test_metrics.py,sha256=-9RM5BGb-oqHl6JNPHIzVTsxPSPBvcHeMxDJqqqnlGs,1374
+tests/test_node.py,sha256=9nkrnAP8TnmtSXc83w-e8QJaCG56pzgTbdnueZZrta0,1049
+tests/test_path.py,sha256=Dg6NQ7Oz9UrvM4dqNOh-80odzCEWl8q2vM3BAGxpmqA,1091
+tests/test_topology.py,sha256=TnGKrtYRPG9wO85lCpVLg6MoOYhHgkWrwjA40xE652g,6258
+tests/test_version.py,sha256=rJheq9nRxTaSmvl5yEFGPNmwnMa0I-NkSu2oH47jpt0,253
+topolib/__init__.py,sha256=iLmy2rOkHS_4KZWMD8BgT7R3tLMKeaTCDVf3B4FyYxM,91
+topolib/analysis/__init__.py,sha256=qvUC9wV_jQNQIlwJXk7LJ-dkTXhH1Ttn0lKWIdwBbrc,52
+topolib/analysis/metrics.py,sha256=Di4HGHlz9c2UTCYdfnmjtPjo7w3wwYuyDPeXI7bR0zA,2592
+topolib/assets/Abilene_IXP.json,sha256=5cnPMbjsNDjmpySdQDYQ2yd83zOFvCRjlAnbX1wyzgk,6010
+topolib/assets/China_pop.json,sha256=v-bs5qib8-CB81rvBNNM9ssoelrNGuFrPEyRCht9YpY,22262
+topolib/assets/DT-50_pop.json,sha256=hCv1MCvipgdrQ34VT-qXJ68BdATriQ8ZObh0fLPqar4,29719
+topolib/elements/__init__.py,sha256=ZWSd5uwVtppJtMnZ30zrAdzXhUAYIK62RrUaH9rsWu0,180
+topolib/elements/link.py,sha256=BwjdCR8peh7dDpKunZodlIsjKcfvwjKxyQ3tmp1obb8,3778
+topolib/elements/node.py,sha256=uOnljwA3jcVR4utUfI-om4SIt_QBsEQt8QLW9uvjr3Y,4974
+topolib/topology/__init__.py,sha256=2VRhVm4ZvKBiTDB2T8BDmLZBpwGCVFRF3fvtxxC_d28,86
+topolib/topology/path.py,sha256=oUNwmpBcS6LMMAJIxokROm3MVqr7vRR44M3Fh5ADq_w,2057
+topolib/topology/topology.py,sha256=PzPx80TxWMcOwpOCh4fohcWT2YUra-4m04tBjqyMU40,5605
+topolib/visualization/__init__.py,sha256=wv065-KB5uDbTaQIASPVfMMW5sE76Bs-q0oai48vAzk,29
+topolib/visualization/mapview.py,sha256=4iKJMYsH6oFNj9tOcgSKLVRtoYfUuH3XLjShsGwUXcM,2799
+topolib-0.0.0.dist-info/licenses/LICENSE,sha256=kbnIP0XU6f2ualiTjEawdlU81IGPBbwc-_GF3N-1e9E,1081
+topolib-0.0.0.dist-info/METADATA,sha256=4OEpNmsfDsL7k0230z4ObnVFu3o2mKT_SEeJifiE8P4,4294
+topolib-0.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+topolib-0.0.0.dist-info/top_level.txt,sha256=7ynOTanzCkVNSIj7GUDQ1TveIoSt3tcfSi0I0JYTrq0,37
+topolib-0.0.0.dist-info/RECORD,,

topolib-0.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

topolib-0.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2025 Danilo Bórquez-Paredes
+
+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.

topolib-0.0.0.dist-info/top_level.txt

@@ -0,0 +1,5 @@
+diagrams
+docs
+examples
+tests
+topolib