topolib 0.3.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

{elements → topolib/elements}/node.py

@@ -21,13 +21,75 @@ class Node:
     :type latitude: float
     :param longitude: Longitude coordinate of the node.
     :type longitude: float
+    :param weight: Node weight (optional, default 0).
+    :type weight: float or int
+    :param pop: Node population (optional, default 0).
+    :type pop: int
+    :param dc: Datacenter (DC) value for the node (optional, default 0).
+    :type dc: int
+    :param ixp: IXP (Internet Exchange Point) value for the node (optional, default 0).
+    :type ixp: int
     """
 
-    def __init__(self, id: int, name: str, latitude: float, longitude: float):
+    def __init__(
+        self,
+        id: int,
+        name: str,
+        latitude: float,
+        longitude: float,
+        weight: float = 0,
+        pop: int = 0,
+        dc: int = 0,
+        ixp: int = 0,
+    ):
         self._id = id
         self._name = name
         self._latitude = latitude
         self._longitude = longitude
+        self._weight = weight
+        self._pop = pop
+        self._dc = dc
+        self._ixp = ixp
+
+    @property
+    def dc(self) -> int:
+        """
+        Get the datacenter (DC) count or value for the node.
+
+        :return: Node DC value.
+        :rtype: int
+        """
+        return self._dc
+
+    @dc.setter
+    def dc(self, value: int) -> None:
+        """
+        Set the datacenter (DC) value for the node.
+
+        :param value: Node DC value.
+        :type value: int
+        """
+        self._dc = value
+
+    @property
+    def ixp(self) -> int:
+        """
+        Get the IXP (Internet Exchange Point) count or value for the node.
+
+        :return: Node IXP value.
+        :rtype: int
+        """
+        return self._ixp
+
+    @ixp.setter
+    def ixp(self, value: int) -> None:
+        """
+        Set the IXP (Internet Exchange Point) value for the node.
+
+        :param value: Node IXP value.
+        :type value: int
+        """
+        self._ixp = value
 
     @property
     def id(self) -> int:
@@ -109,6 +171,46 @@ class Node:
         """
         self._longitude = value
 
+    @property
+    def weight(self) -> float:
+        """
+        Get the weight of the node.
+
+        :return: Node weight.
+        :rtype: float
+        """
+        return self._weight
+
+    @weight.setter
+    def weight(self, value: float) -> None:
+        """
+        Set the weight of the node.
+
+        :param value: Node weight.
+        :type value: float
+        """
+        self._weight = value
+
+    @property
+    def pop(self) -> int:
+        """
+        Get the population of the node.
+
+        :return: Node population.
+        :rtype: int
+        """
+        return self._pop
+
+    @pop.setter
+    def pop(self, value: int) -> None:
+        """
+        Set the population of the node.
+
+        :param value: Node population.
+        :type value: int
+        """
+        self._pop = value
+
     def coordinates(self) -> Tuple[float, float]:
         """
         Returns the (latitude, longitude) coordinates of the node.

{topology → topolib/topology}/topology.py

@@ -8,7 +8,7 @@ This file uses NetworkX (BSD 3-Clause License):
 https://github.com/networkx/networkx/blob/main/LICENSE.txt
 """
 
-from typing import List, Dict, Any
+from typing import List, Dict, Any, Optional
 import numpy as np
 import networkx as nx
 from topolib.elements.node import Node
@@ -42,17 +42,25 @@ class Topology:
                [1, 0]])
     """
 
-    def __init__(self, nodes: List[Node] = None, links: List[Link] = None):
+    def __init__(
+        self,
+        nodes: Optional[List[Node]] = None,
+        links: Optional[List[Link]] = None,
+        name: Optional[str] = None,
+    ):
         """
         Initialize a Topology object.
 
-    :param nodes: Initial list of nodes (optional).
-    :type nodes: list[topolib.elements.node.Node] or None
-    :param links: Initial list of links (optional).
-    :type links: list[topolib.elements.link.Link] or None
+        :param nodes: Initial list of nodes (optional).
+        :type nodes: list[topolib.elements.node.Node] or None
+        :param links: Initial list of links (optional).
+        :type links: list[topolib.elements.link.Link] or None
+        :param name: Name of the topology (optional).
+        :type name: str or None
         """
-        self.nodes: List[Node] = nodes if nodes is not None else []
-        self.links: List[Link] = links if links is not None else []
+        self.nodes = nodes if nodes is not None else []
+        self.links = links if links is not None else []
+        self.name = name
         # Internal NetworkX graph for algorithms and visualization
         self._graph = nx.Graph()
         for node in self.nodes:
@@ -60,6 +68,44 @@ class Topology:
         for link in self.links:
             self._graph.add_edge(link.source.id, link.target.id, link=link)
 
+    @classmethod
+    def from_json(cls, json_path: str) -> "Topology":
+        """
+        Create a Topology object from a JSON file.
+
+        :param json_path: Path to the JSON file containing the topology.
+        :type json_path: str
+        :return: Topology instance loaded from the file.
+        :rtype: Topology
+        """
+        import json
+        from topolib.elements.node import Node
+        from topolib.elements.link import Link
+
+        with open(json_path, "r", encoding="utf-8") as f:
+            data = json.load(f)
+        nodes = [
+            Node(
+                n["id"],
+                n["name"],
+                n["latitude"],
+                n["longitude"],
+                n.get("weight", 0),
+                n.get("pop", 0),
+                n.get("dc", n.get("DC", 0)),
+                n.get("ixp", n.get("IXP", 0)),
+            )
+            for n in data["nodes"]
+        ]
+        # Crear un dict para mapear id a Node
+        node_dict = {n.id: n for n in nodes}
+        links = [
+            Link(l["id"], node_dict[l["src"]], node_dict[l["dst"]], l["length"])
+            for l in data["links"]
+        ]
+        name = data.get("name", None)
+        return cls(nodes=nodes, links=links, name=name)
+
     def add_node(self, node: Node) -> None:
         """
         Add a node to the topology.

topolib/visualization/__init__.py

@@ -0,0 +1 @@
+from .mapview import MapView

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.4.2.dist-info/METADATA

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: topolib
+Version: 0.4.2
+Summary: A compact Python library for modeling, analyzing, and visualizing optical network topologies.
+License: MIT
+License-File: LICENSE
+Keywords: network,topology,optical,analysis,visualization
+Author: Danilo Bórquez-Paredes
+Author-email: danilo.borquez.p@uai.cl
+Requires-Python: >=3.10
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: contextily
+Requires-Dist: geopandas
+Requires-Dist: matplotlib
+Requires-Dist: networkx (>=2.6)
+Requires-Dist: numpy (>=1.21)
+Requires-Dist: shapely
+Project-URL: Documentation, https://topolib.readthedocs.io/
+Project-URL: Homepage, https://gitlab.com/DaniloBorquez/topolib
+Project-URL: Repository, https://gitlab.com/DaniloBorquez/topolib
+Description-Content-Type: text/markdown
+
+# Topolib 🚀
+# 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)
+
+> **Topolib** is a compact, modular Python library for modeling, analyzing, and visualizing optical network topologies.  
+> **Goal:** Provide researchers and engineers with a simple, extensible toolkit for working with nodes, links, metrics, and map-based visualizations.  
+>   
+> 🌐 **Model** | 📊 **Analyze** | 🗺️ **Visualize** | 🧩 **Extend**
+
+---
+
+## 📂 Examples
+
+Explore ready-to-run usage examples in the [`examples/`](examples/) folder!  
+- [Show topology on a map](examples/show_topology_in_map.py) 🗺️  
+- More coming soon!
+
+---
+
+## 🧭 Overview
+
+Topolib is organized into four main modules:
+
+- 🧱 **Elements:** `Node`, `Link` — basic building blocks
+- 🕸️ **Topology:** `Topology`, `Path` — manage nodes, links, paths, and adjacency
+- 📈 **Analysis:** `Metrics` — compute node degree, link stats, connection matrices
+- 🖼️ **Visualization:** `MapView` — plot topologies on real maps
+
+---
+
+## ✨ Features
+
+- Modular, extensible design
+- 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
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -U pip
+pip install topolib
+```
+
+---
+
+## 📚 Documentation
+
+Full documentation: [https://topolib.readthedocs.io/](https://topolib.readthedocs.io/)
+
+---
+
+## 📝 Basic usage
+
+```python
+from topolib.elements.node import Node
+from topolib.topology.topology import Topology
+
+n1 = Node(1, 'A', 10.0, 20.0)
+n2 = Node(2, 'B', 11.0, 21.0)
+topo = Topology(nodes=[n1, n2])
+# Add links, compute metrics, visualize, etc.
+```
+
+---
+
+## 🛠️ Development
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for development guidelines, commit message rules, and pre-commit setup.
+
+---
+
+## 📄 License
+
+MIT — see [`LICENSE`](LICENSE) for details.
+

topolib-0.4.2.dist-info/RECORD

@@ -0,0 +1,18 @@
+topolib/__init__.py,sha256=iLmy2rOkHS_4KZWMD8BgT7R3tLMKeaTCDVf3B4FyYxM,91
+topolib/analysis/__init__.py,sha256=qvUC9wV_jQNQIlwJXk7LJ-dkTXhH1Ttn0lKWIdwBbrc,52
+topolib/analysis/metrics.py,sha256=2o5PlMVzepDWwSQjzamtKemggqkxh9JuzzCUaeahfok,2555
+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.4.2.dist-info/METADATA,sha256=O2V7bL8xtAJOhNVmbLX0mHLj1ic5ZZu_3bbnFFbEzAw,3993
+topolib-0.4.2.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+topolib-0.4.2.dist-info/licenses/LICENSE,sha256=kbnIP0XU6f2ualiTjEawdlU81IGPBbwc-_GF3N-1e9E,1081
+topolib-0.4.2.dist-info/RECORD,,

{topolib-0.3.0.dist-info → topolib-0.4.2.dist-info}/WHEEL

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