topolib 0.3.0__tar.gz → 0.4.2__tar.gz

topolib-0.4.2/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,86 @@
+# 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/pyproject.toml

@@ -0,0 +1,52 @@
+
+[tool.poetry]
+name = "topolib"
+# Poetry requires a version field, but poetry-dynamic-versioning will override it
+version = "0.4.2"
+description = "A compact Python library for modeling, analyzing, and visualizing optical network topologies."
+authors = ["Danilo Bórquez-Paredes <danilo.borquez.p@uai.cl>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://gitlab.com/DaniloBorquez/topolib"
+documentation = "https://topolib.readthedocs.io/"
+homepage = "https://gitlab.com/DaniloBorquez/topolib"
+keywords = ["network", "topology", "optical", "analysis", "visualization"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+packages = [
+    { include = "topolib" }
+]
+
+[tool.poetry.dependencies]
+python = ">=3.10"
+numpy = ">=1.21"
+networkx = ">=2.6"
+matplotlib = "*"
+contextily = "*"
+geopandas = "*"
+shapely = "*"
+
+
+[tool.poetry.group.dev.dependencies]
+pytest = "*"
+pytest-cov = "*"
+matplotlib = "*"
+contextily = "*"
+geopandas = "*"
+shapely = "*"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry-dynamic-versioning]
+enable = false
+vcs = "git"
+style = "pep440"
+pattern = '(?P<base>\d+\.\d+\.\d+)'
+

topolib-0.4.2/topolib/__init__.py

@@ -0,0 +1,4 @@
+try:
+    from ._version import __version__
+except ImportError:
+    __version__ = "unknown"

{topolib-0.3.0 → topolib-0.4.2}/topolib/analysis/metrics.py

@@ -2,7 +2,7 @@
 Metrics module for network topology analysis.
 """
 
-from typing import List, Any, Dict, Optional
+from typing import List, Dict, Optional
 
 
 from topolib.topology import Topology
@@ -12,16 +12,16 @@ class Metrics:
     """
     Provides static methods for computing metrics on network topologies.
 
-    Todos los métodos reciben una instancia de Topology.
+    All methods receive a Topology instance.
 
-    Métodos
+    Methods
     -------
     node_degree(topology)
-        Calcula el grado de cada nodo.
+        Calculates the degree of each node.
     link_length_stats(topology)
-        Calcula estadísticas (min, max, avg) de las longitudes de los enlaces.
+        Calculates statistics (min, max, avg) of link lengths.
     connection_matrix(topology)
-        Construye la matriz de adyacencia.
+        Builds the adjacency matrix.
     """
 
     @staticmethod

topolib-0.4.2/topolib/assets/Abilene_IXP.json

@@ -0,0 +1,285 @@
+{
+    "name": "Abilene",
+    "nodes": [
+        {
+            "id": 0,
+            "name": "Seattle",
+            "weight": 0,
+            "longitude": -122.3328481,
+            "latitude": 47.6061389,
+            "pop": 780995,
+            "DC": 58,
+            "IXP": 5
+        },
+        {
+            "id": 1,
+            "name": "Sunnyvale",
+            "weight": 0,
+            "longitude": -122.0363496,
+            "latitude": 37.36883,
+            "pop": 155805,
+            "DC": 0,
+            "IXP": 0
+        },
+        {
+            "id": 2,
+            "name": "Los Angeles",
+            "weight": 0,
+            "longitude": -118.242643,
+            "latitude": 34.0549076,
+            "pop": 3820914,
+            "DC": 71,
+            "IXP": 9
+        },
+        {
+            "id": 3,
+            "name": "Denver",
+            "weight": 0,
+            "longitude": -104.990251,
+            "latitude": 39.7392358,
+            "pop": 729019,
+            "DC": 49,
+            "IXP": 6
+        },
+        {
+            "id": 4,
+            "name": "Kansas City",
+            "weight": 0,
+            "longitude": -94.5785667,
+            "latitude": 39.0997265,
+            "pop": 475378,
+            "DC": 25,
+            "IXP": 1
+        },
+        {
+            "id": 5,
+            "name": "Houston",
+            "weight": 0,
+            "longitude": -95.3701108,
+            "latitude": 29.7600771,
+            "pop": 2314157,
+            "DC": 55,
+            "IXP": 6
+        },
+        {
+            "id": 6,
+            "name": "Atlanta",
+            "weight": 0,
+            "longitude": -84.3885209,
+            "latitude": 33.7501275,
+            "pop": 510823,
+            "DC": 145,
+            "IXP": 7
+        },
+        {
+            "id": 7,
+            "name": "Indianapolis",
+            "weight": 0,
+            "longitude": -86.158018,
+            "latitude": 39.76909,
+            "pop": 887642,
+            "DC": 30,
+            "IXP": 2
+        },
+        {
+            "id": 8,
+            "name": "Chicago",
+            "weight": 0,
+            "longitude": -87.6323879,
+            "latitude": 41.88325,
+            "pop": 2664452,
+            "DC": 165,
+            "IXP": 10
+        },
+        {
+            "id": 9,
+            "name": "Washington D.C.",
+            "weight": 0,
+            "longitude": -77.0368707,
+            "latitude": 38.9071923,
+            "pop": 689545,
+            "DC": 7,
+            "IXP": 3
+        },
+        {
+            "id": 10,
+            "name": "New York",
+            "weight": 0,
+            "longitude": -74.0059728,
+            "latitude": 40.7127753,
+            "pop": 8804190,
+            "DC": 70,
+            "IXP": 11
+        }
+    ],
+    "links": [
+        {
+            "id": 0,
+            "src": 0,
+            "dst": 1,
+            "length": 1482.26
+        },
+        {
+            "id": 1,
+            "src": 2,
+            "dst": 1,
+            "length": 649.31
+        },
+        {
+            "id": 2,
+            "src": 5,
+            "dst": 2,
+            "length": 2870.2
+        },
+        {
+            "id": 3,
+            "src": 4,
+            "dst": 5,
+            "length": 1360.7
+        },
+        {
+            "id": 4,
+            "src": 3,
+            "dst": 0,
+            "length": 2123.16
+        },
+        {
+            "id": 5,
+            "src": 3,
+            "dst": 1,
+            "length": 1949.85
+        },
+        {
+            "id": 6,
+            "src": 4,
+            "dst": 3,
+            "length": 1153.26
+        },
+        {
+            "id": 7,
+            "src": 8,
+            "dst": 7,
+            "length": 345.36
+        },
+        {
+            "id": 8,
+            "src": 4,
+            "dst": 7,
+            "length": 933.65
+        },
+        {
+            "id": 9,
+            "src": 5,
+            "dst": 6,
+            "length": 1471.24
+        },
+        {
+            "id": 10,
+            "src": 6,
+            "dst": 7,
+            "length": 912.61
+        },
+        {
+            "id": 11,
+            "src": 10,
+            "dst": 8,
+            "length": 1489.76
+        },
+        {
+            "id": 12,
+            "src": 6,
+            "dst": 9,
+            "length": 1126.74
+        },
+        {
+            "id": 13,
+            "src": 9,
+            "dst": 10,
+            "length": 416.12
+        },
+        {
+            "id": 14,
+            "src": 1,
+            "dst": 0,
+            "length": 1482.26
+        },
+        {
+            "id": 15,
+            "src": 1,
+            "dst": 2,
+            "length": 649.31
+        },
+        {
+            "id": 16,
+            "src": 2,
+            "dst": 5,
+            "length": 2870.2
+        },
+        {
+            "id": 17,
+            "src": 5,
+            "dst": 4,
+            "length": 1360.7
+        },
+        {
+            "id": 18,
+            "src": 0,
+            "dst": 3,
+            "length": 2123.16
+        },
+        {
+            "id": 19,
+            "src": 1,
+            "dst": 3,
+            "length": 1949.85
+        },
+        {
+            "id": 20,
+            "src": 3,
+            "dst": 4,
+            "length": 1153.26
+        },
+        {
+            "id": 21,
+            "src": 7,
+            "dst": 8,
+            "length": 345.36
+        },
+        {
+            "id": 22,
+            "src": 7,
+            "dst": 4,
+            "length": 933.65
+        },
+        {
+            "id": 23,
+            "src": 6,
+            "dst": 5,
+            "length": 1471.24
+        },
+        {
+            "id": 24,
+            "src": 7,
+            "dst": 6,
+            "length": 912.61
+        },
+        {
+            "id": 25,
+            "src": 8,
+            "dst": 10,
+            "length": 1489.76
+        },
+        {
+            "id": 26,
+            "src": 9,
+            "dst": 6,
+            "length": 1126.74
+        },
+        {
+            "id": 27,
+            "src": 10,
+            "dst": 9,
+            "length": 416.12
+        }
+    ]
+}