tensor-network-visualization 1.5.4__tar.gz → 1.6.0__tar.gz

{tensor_network_visualization-1.5.4 → tensor_network_visualization-1.6.0}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Alejandro Mata Ali
-
-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.
+MIT License
+
+Copyright (c) 2026 Alejandro Mata Ali
+
+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.

tensor_network_visualization-1.6.0/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: tensor-network-visualization
+Version: 1.6.0
+Summary: Minimal Matplotlib visualizations for TensorKrowch, TensorNetwork, Quimb, TeNPy, and traced PyTorch/NumPy einsum tensor networks.
+Author: Alejandro Mata Ali
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization
+Project-URL: Documentation, https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/blob/main/docs/guide.md
+Project-URL: Changelog, https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/blob/main/CHANGELOG.md
+Project-URL: Repository, https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization
+Project-URL: Issues, https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/issues
+Keywords: tensor-network,visualization,pytorch,numpy,tensorkrowch,tensornetwork,quimb,tenpy,einsum,quantum-inspired,matplotlib
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: networkx>=3.0
+Requires-Dist: numpy
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Requires-Dist: tensorkrowch; extra == "dev"
+Requires-Dist: tensornetwork; extra == "dev"
+Requires-Dist: quimb; extra == "dev"
+Requires-Dist: physics-tenpy; extra == "dev"
+Provides-Extra: jupyter
+Requires-Dist: ipympl>=0.9.0; extra == "jupyter"
+Requires-Dist: ipywidgets>=8.0; extra == "jupyter"
+Requires-Dist: jupyterlab>=4.0; extra == "jupyter"
+Requires-Dist: notebook>=7.0; extra == "jupyter"
+Provides-Extra: tensorkrowch
+Requires-Dist: tensorkrowch; extra == "tensorkrowch"
+Provides-Extra: tensornetwork
+Requires-Dist: tensornetwork; extra == "tensornetwork"
+Provides-Extra: quimb
+Requires-Dist: quimb; extra == "quimb"
+Provides-Extra: tenpy
+Requires-Dist: physics-tenpy; extra == "tenpy"
+Provides-Extra: einsum
+Requires-Dist: torch; extra == "einsum"
+Dynamic: license-file
+
+# Tensor-Network-Visualization
+
+[![CI](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/actions/workflows/ci.yml/badge.svg)](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/tensor-network-visualization.svg)](https://pypi.org/project/tensor-network-visualization/)
+[![Python versions](https://img.shields.io/pypi/pyversions/tensor-network-visualization.svg)](https://pypi.org/project/tensor-network-visualization/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Minimal Matplotlib visualizations for TensorKrowch, TensorNetwork, Quimb, TeNPy, and traced
+PyTorch/NumPy `einsum` tensor networks.
+
+## Why This Exists
+
+Tensor-network libraries expose different Python objects. This package gives them a small shared
+visualization API so you can inspect structure, tensor values, contraction playback, and normalized
+graph exports without rewriting plotting code for every backend.
+
+The common entry points are:
+
+```python
+show_tensor_network(...)
+show_tensor_elements(...)
+show_tensor_comparison(...)
+normalize_tensor_network(...)
+export_tensor_network_snapshot(...)
+```
+
+## Install
+
+- PyPI package name: `tensor-network-visualization`
+- Import package: `tensor_network_viz`
+- Requires Python 3.11 or newer.
+
+```bash
+python -m pip install tensor-network-visualization
+```
+
+The base install only depends on `numpy`, `matplotlib`, and `networkx`.
+
+For interactive Jupyter figures:
+
+```bash
+python -m pip install "tensor-network-visualization[jupyter]"
+```
+
+For backend-specific packages, install the matching extra, for example:
+
+```bash
+python -m pip install "tensor-network-visualization[quimb]"
+```
+
+See [docs/installation.md](docs/installation.md) for virtual environments, all optional extras, and
+local development installs.
+
+## Basic Usage
+
+### NumPy `einsum` trace (base install)
+
+This example uses only base dependencies and a NumPy-backed `EinsumTrace`.
+
+```python
+import numpy as np
+from tensor_network_viz import EinsumTrace, PlotConfig, einsum, show_tensor_network
+
+trace = EinsumTrace()
+a = np.ones((2, 3), dtype=float)
+x = np.array([1.0, -0.5, 0.25], dtype=float)
+
+trace.bind("A", a)
+trace.bind("x", x)
+einsum("ab,b->a", a, x, trace=trace, backend="numpy")
+
+fig, ax = show_tensor_network(
+    trace,
+    config=PlotConfig(show_tensor_labels=True, hover_labels=True),
+    show=False,
+)
+fig.savefig("einsum-network.png", bbox_inches="tight")
+```
+
+### TensorKrowch
+
+Install the TensorKrowch extra (see [Installation](docs/installation.md) for details):
+
+```bash
+python -m pip install "tensor-network-visualization[tensorkrowch]"
+```
+
+```python
+import tensorkrowch as tk
+from tensor_network_viz import PlotConfig, show_tensor_network
+
+network = tk.TensorNetwork(name="demo")
+left = tk.Node(shape=(2, 2), axes_names=("a", "b"), name="L", network=network)
+right = tk.Node(shape=(2, 2), axes_names=("b", "c"), name="R", network=network)
+left["b"] ^ right["b"]
+
+fig, ax = show_tensor_network(
+    network,
+    config=PlotConfig(show_tensor_labels=True, show_index_labels=False),
+    show=False,
+)
+fig.savefig("tensorkrowch-network.png", bbox_inches="tight")
+```
+
+Use `show=False` when you want to save or customize the figure yourself. Use
+`show_controls=False` when you want a clean static figure with no embedded Matplotlib controls.
+
+In Jupyter, install `"tensor-network-visualization[jupyter]"`, run `%matplotlib widget` before
+plotting, then call `show_tensor_network` as usual (default `show_controls=True`) for interactive
+figures with embedded controls. See [Installation](docs/installation.md) and
+[User Guide](docs/guide.md) for details.
+
+## Documentation
+
+- [Installation](docs/installation.md): virtual environments, optional extras, Jupyter, and local
+  editable installs.
+- [API Reference](docs/api.md): public functions, configuration objects, snapshots, exceptions, and
+  logging.
+- [User Guide](docs/guide.md): workflows, notebooks, exports, layouts, tensor inspection,
+  comparisons, snapshots, and performance tips.
+- [Backend Examples](docs/backends.md): copy-paste examples for TensorKrowch, TensorNetwork, Quimb,
+  TeNPy, and `einsum`.
+- [Troubleshooting](docs/troubleshooting.md): common install, Jupyter, Matplotlib, backend, and data
+  issues.
+- [Repository Examples](examples/README.md): command-line demo launcher and example catalog.
+
+## Project Links
+
+- [Changelog](CHANGELOG.md)
+- [Contributing](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Issues](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/issues)
+- [Repository](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization)

tensor_network_visualization-1.6.0/README.md

@@ -0,0 +1,133 @@
+# Tensor-Network-Visualization
+
+[![CI](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/actions/workflows/ci.yml/badge.svg)](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/tensor-network-visualization.svg)](https://pypi.org/project/tensor-network-visualization/)
+[![Python versions](https://img.shields.io/pypi/pyversions/tensor-network-visualization.svg)](https://pypi.org/project/tensor-network-visualization/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Minimal Matplotlib visualizations for TensorKrowch, TensorNetwork, Quimb, TeNPy, and traced
+PyTorch/NumPy `einsum` tensor networks.
+
+## Why This Exists
+
+Tensor-network libraries expose different Python objects. This package gives them a small shared
+visualization API so you can inspect structure, tensor values, contraction playback, and normalized
+graph exports without rewriting plotting code for every backend.
+
+The common entry points are:
+
+```python
+show_tensor_network(...)
+show_tensor_elements(...)
+show_tensor_comparison(...)
+normalize_tensor_network(...)
+export_tensor_network_snapshot(...)
+```
+
+## Install
+
+- PyPI package name: `tensor-network-visualization`
+- Import package: `tensor_network_viz`
+- Requires Python 3.11 or newer.
+
+```bash
+python -m pip install tensor-network-visualization
+```
+
+The base install only depends on `numpy`, `matplotlib`, and `networkx`.
+
+For interactive Jupyter figures:
+
+```bash
+python -m pip install "tensor-network-visualization[jupyter]"
+```
+
+For backend-specific packages, install the matching extra, for example:
+
+```bash
+python -m pip install "tensor-network-visualization[quimb]"
+```
+
+See [docs/installation.md](docs/installation.md) for virtual environments, all optional extras, and
+local development installs.
+
+## Basic Usage
+
+### NumPy `einsum` trace (base install)
+
+This example uses only base dependencies and a NumPy-backed `EinsumTrace`.
+
+```python
+import numpy as np
+from tensor_network_viz import EinsumTrace, PlotConfig, einsum, show_tensor_network
+
+trace = EinsumTrace()
+a = np.ones((2, 3), dtype=float)
+x = np.array([1.0, -0.5, 0.25], dtype=float)
+
+trace.bind("A", a)
+trace.bind("x", x)
+einsum("ab,b->a", a, x, trace=trace, backend="numpy")
+
+fig, ax = show_tensor_network(
+    trace,
+    config=PlotConfig(show_tensor_labels=True, hover_labels=True),
+    show=False,
+)
+fig.savefig("einsum-network.png", bbox_inches="tight")
+```
+
+### TensorKrowch
+
+Install the TensorKrowch extra (see [Installation](docs/installation.md) for details):
+
+```bash
+python -m pip install "tensor-network-visualization[tensorkrowch]"
+```
+
+```python
+import tensorkrowch as tk
+from tensor_network_viz import PlotConfig, show_tensor_network
+
+network = tk.TensorNetwork(name="demo")
+left = tk.Node(shape=(2, 2), axes_names=("a", "b"), name="L", network=network)
+right = tk.Node(shape=(2, 2), axes_names=("b", "c"), name="R", network=network)
+left["b"] ^ right["b"]
+
+fig, ax = show_tensor_network(
+    network,
+    config=PlotConfig(show_tensor_labels=True, show_index_labels=False),
+    show=False,
+)
+fig.savefig("tensorkrowch-network.png", bbox_inches="tight")
+```
+
+Use `show=False` when you want to save or customize the figure yourself. Use
+`show_controls=False` when you want a clean static figure with no embedded Matplotlib controls.
+
+In Jupyter, install `"tensor-network-visualization[jupyter]"`, run `%matplotlib widget` before
+plotting, then call `show_tensor_network` as usual (default `show_controls=True`) for interactive
+figures with embedded controls. See [Installation](docs/installation.md) and
+[User Guide](docs/guide.md) for details.
+
+## Documentation
+
+- [Installation](docs/installation.md): virtual environments, optional extras, Jupyter, and local
+  editable installs.
+- [API Reference](docs/api.md): public functions, configuration objects, snapshots, exceptions, and
+  logging.
+- [User Guide](docs/guide.md): workflows, notebooks, exports, layouts, tensor inspection,
+  comparisons, snapshots, and performance tips.
+- [Backend Examples](docs/backends.md): copy-paste examples for TensorKrowch, TensorNetwork, Quimb,
+  TeNPy, and `einsum`.
+- [Troubleshooting](docs/troubleshooting.md): common install, Jupyter, Matplotlib, backend, and data
+  issues.
+- [Repository Examples](examples/README.md): command-line demo launcher and example catalog.
+
+## Project Links
+
+- [Changelog](CHANGELOG.md)
+- [Contributing](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Issues](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/issues)
+- [Repository](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization)

{tensor_network_visualization-1.5.4 → tensor_network_visualization-1.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tensor-network-visualization"
-version = "1.5.4"
+version = "1.6.0"
 description = "Minimal Matplotlib visualizations for TensorKrowch, TensorNetwork, Quimb, TeNPy, and traced PyTorch/NumPy einsum tensor networks."
 authors = [{ name = "Alejandro Mata Ali" }]
 readme = "README.md"

tensor_network_visualization-1.6.0/src/tensor_network_visualization.egg-info/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: tensor-network-visualization
+Version: 1.6.0
+Summary: Minimal Matplotlib visualizations for TensorKrowch, TensorNetwork, Quimb, TeNPy, and traced PyTorch/NumPy einsum tensor networks.
+Author: Alejandro Mata Ali
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization
+Project-URL: Documentation, https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/blob/main/docs/guide.md
+Project-URL: Changelog, https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/blob/main/CHANGELOG.md
+Project-URL: Repository, https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization
+Project-URL: Issues, https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/issues
+Keywords: tensor-network,visualization,pytorch,numpy,tensorkrowch,tensornetwork,quimb,tenpy,einsum,quantum-inspired,matplotlib
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: networkx>=3.0
+Requires-Dist: numpy
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Requires-Dist: tensorkrowch; extra == "dev"
+Requires-Dist: tensornetwork; extra == "dev"
+Requires-Dist: quimb; extra == "dev"
+Requires-Dist: physics-tenpy; extra == "dev"
+Provides-Extra: jupyter
+Requires-Dist: ipympl>=0.9.0; extra == "jupyter"
+Requires-Dist: ipywidgets>=8.0; extra == "jupyter"
+Requires-Dist: jupyterlab>=4.0; extra == "jupyter"
+Requires-Dist: notebook>=7.0; extra == "jupyter"
+Provides-Extra: tensorkrowch
+Requires-Dist: tensorkrowch; extra == "tensorkrowch"
+Provides-Extra: tensornetwork
+Requires-Dist: tensornetwork; extra == "tensornetwork"
+Provides-Extra: quimb
+Requires-Dist: quimb; extra == "quimb"
+Provides-Extra: tenpy
+Requires-Dist: physics-tenpy; extra == "tenpy"
+Provides-Extra: einsum
+Requires-Dist: torch; extra == "einsum"
+Dynamic: license-file
+
+# Tensor-Network-Visualization
+
+[![CI](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/actions/workflows/ci.yml/badge.svg)](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/tensor-network-visualization.svg)](https://pypi.org/project/tensor-network-visualization/)
+[![Python versions](https://img.shields.io/pypi/pyversions/tensor-network-visualization.svg)](https://pypi.org/project/tensor-network-visualization/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Minimal Matplotlib visualizations for TensorKrowch, TensorNetwork, Quimb, TeNPy, and traced
+PyTorch/NumPy `einsum` tensor networks.
+
+## Why This Exists
+
+Tensor-network libraries expose different Python objects. This package gives them a small shared
+visualization API so you can inspect structure, tensor values, contraction playback, and normalized
+graph exports without rewriting plotting code for every backend.
+
+The common entry points are:
+
+```python
+show_tensor_network(...)
+show_tensor_elements(...)
+show_tensor_comparison(...)
+normalize_tensor_network(...)
+export_tensor_network_snapshot(...)
+```
+
+## Install
+
+- PyPI package name: `tensor-network-visualization`
+- Import package: `tensor_network_viz`
+- Requires Python 3.11 or newer.
+
+```bash
+python -m pip install tensor-network-visualization
+```
+
+The base install only depends on `numpy`, `matplotlib`, and `networkx`.
+
+For interactive Jupyter figures:
+
+```bash
+python -m pip install "tensor-network-visualization[jupyter]"
+```
+
+For backend-specific packages, install the matching extra, for example:
+
+```bash
+python -m pip install "tensor-network-visualization[quimb]"
+```
+
+See [docs/installation.md](docs/installation.md) for virtual environments, all optional extras, and
+local development installs.
+
+## Basic Usage
+
+### NumPy `einsum` trace (base install)
+
+This example uses only base dependencies and a NumPy-backed `EinsumTrace`.
+
+```python
+import numpy as np
+from tensor_network_viz import EinsumTrace, PlotConfig, einsum, show_tensor_network
+
+trace = EinsumTrace()
+a = np.ones((2, 3), dtype=float)
+x = np.array([1.0, -0.5, 0.25], dtype=float)
+
+trace.bind("A", a)
+trace.bind("x", x)
+einsum("ab,b->a", a, x, trace=trace, backend="numpy")
+
+fig, ax = show_tensor_network(
+    trace,
+    config=PlotConfig(show_tensor_labels=True, hover_labels=True),
+    show=False,
+)
+fig.savefig("einsum-network.png", bbox_inches="tight")
+```
+
+### TensorKrowch
+
+Install the TensorKrowch extra (see [Installation](docs/installation.md) for details):
+
+```bash
+python -m pip install "tensor-network-visualization[tensorkrowch]"
+```
+
+```python
+import tensorkrowch as tk
+from tensor_network_viz import PlotConfig, show_tensor_network
+
+network = tk.TensorNetwork(name="demo")
+left = tk.Node(shape=(2, 2), axes_names=("a", "b"), name="L", network=network)
+right = tk.Node(shape=(2, 2), axes_names=("b", "c"), name="R", network=network)
+left["b"] ^ right["b"]
+
+fig, ax = show_tensor_network(
+    network,
+    config=PlotConfig(show_tensor_labels=True, show_index_labels=False),
+    show=False,
+)
+fig.savefig("tensorkrowch-network.png", bbox_inches="tight")
+```
+
+Use `show=False` when you want to save or customize the figure yourself. Use
+`show_controls=False` when you want a clean static figure with no embedded Matplotlib controls.
+
+In Jupyter, install `"tensor-network-visualization[jupyter]"`, run `%matplotlib widget` before
+plotting, then call `show_tensor_network` as usual (default `show_controls=True`) for interactive
+figures with embedded controls. See [Installation](docs/installation.md) and
+[User Guide](docs/guide.md) for details.
+
+## Documentation
+
+- [Installation](docs/installation.md): virtual environments, optional extras, Jupyter, and local
+  editable installs.
+- [API Reference](docs/api.md): public functions, configuration objects, snapshots, exceptions, and
+  logging.
+- [User Guide](docs/guide.md): workflows, notebooks, exports, layouts, tensor inspection,
+  comparisons, snapshots, and performance tips.
+- [Backend Examples](docs/backends.md): copy-paste examples for TensorKrowch, TensorNetwork, Quimb,
+  TeNPy, and `einsum`.
+- [Troubleshooting](docs/troubleshooting.md): common install, Jupyter, Matplotlib, backend, and data
+  issues.
+- [Repository Examples](examples/README.md): command-line demo launcher and example catalog.
+
+## Project Links
+
+- [Changelog](CHANGELOG.md)
+- [Contributing](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Issues](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization/issues)
+- [Repository](https://github.com/DOKOS-TAYOS/Tensor-Network-Visualization)

{tensor_network_visualization-1.5.4 → tensor_network_visualization-1.6.0}/src/tensor_network_viz/__init__.py

@@ -1,35 +1,37 @@
 """Public package surface with lazy imports for optional backends and viewers."""
 
+from __future__ import annotations
+
 from importlib import import_module
 from typing import TYPE_CHECKING, Any
 
-from matplotlib.axes import Axes
-from matplotlib.figure import Figure
-from mpl_toolkits.mplot3d.axes3d import Axes3D
-
 from . import _logging as _package_logging
-from ._core.graph_cache import clear_tensor_network_graph_cache
-from .config import (
-    EngineName,
-    PlotConfig,
-    TensorNetworkDiagnosticsConfig,
-    TensorNetworkFocus,
-    ViewName,
-)
-from .exceptions import (
-    AxisConfigurationError,
-    MissingOptionalDependencyError,
-    TensorDataError,
-    TensorDataTypeError,
-    TensorNetworkVizError,
-    UnsupportedEngineError,
-    VisualizationInputError,
-    VisualizationTypeError,
-)
 
 if TYPE_CHECKING:
+    from matplotlib.axes import Axes
+    from matplotlib.figure import Figure
+    from mpl_toolkits.mplot3d.axes3d import Axes3D
+
+    from ._core.graph_cache import clear_tensor_network_graph_cache
+    from .config import (
+        EngineName,
+        PlotConfig,
+        TensorNetworkDiagnosticsConfig,
+        TensorNetworkFocus,
+        ViewName,
+    )
     from .contraction_viewer import ContractionViewer2D, ContractionViewer3D
     from .einsum_module.trace import EinsumTrace, einsum, einsum_trace_step, pair_tensor
+    from .exceptions import (
+        AxisConfigurationError,
+        MissingOptionalDependencyError,
+        TensorDataError,
+        TensorDataTypeError,
+        TensorNetworkVizError,
+        UnsupportedEngineError,
+        VisualizationInputError,
+        VisualizationTypeError,
+    )
     from .snapshot import (
         NormalizedContractionStepMetrics,
         NormalizedTensorEdge,
@@ -62,7 +64,8 @@ else:
         """Lazily dispatch to :func:`tensor_network_viz.viewer.show_tensor_network`.
 
         Args:
-            network: Tensor-network input accepted by the public viewer entry point.
+            network: Tensor-network input accepted by the public viewer entry point,
+                including flat iterables and nested 2D/3D grids with ``None`` holes.
             engine: Optional backend override.
             view: Optional initial view name.
             config: Optional plotting configuration.
@@ -89,7 +92,7 @@ else:
         data: Any,
         *,
         engine: EngineName | None = None,
-        config: "TensorElementsConfig | None" = None,
+        config: TensorElementsConfig | None = None,
         ax: Axes | None = None,
         show_controls: bool = True,
         show: bool = True,
@@ -124,8 +127,8 @@ else:
         reference: Any,
         *,
         engine: EngineName | None = None,
-        config: "TensorElementsConfig | None" = None,
-        comparison_config: "TensorComparisonConfig | None" = None,
+        config: TensorElementsConfig | None = None,
+        comparison_config: TensorComparisonConfig | None = None,
         ax: Axes | None = None,
         show_controls: bool = True,
         show: bool = True,
@@ -146,20 +149,34 @@ else:
 
 
 _LAZY_EXPORTS: dict[str, tuple[str, str]] = {
+    "AxisConfigurationError": (".exceptions", "AxisConfigurationError"),
     "ContractionViewer2D": (".contraction_viewer", "ContractionViewer2D"),
     "ContractionViewer3D": (".contraction_viewer", "ContractionViewer3D"),
+    "EngineName": (".config", "EngineName"),
     "EinsumTrace": (".einsum_module.trace", "EinsumTrace"),
+    "MissingOptionalDependencyError": (".exceptions", "MissingOptionalDependencyError"),
     "NormalizedContractionStepMetrics": (".snapshot", "NormalizedContractionStepMetrics"),
     "NormalizedTensorEdge": (".snapshot", "NormalizedTensorEdge"),
     "NormalizedTensorEndpoint": (".snapshot", "NormalizedTensorEndpoint"),
     "NormalizedTensorGraph": (".snapshot", "NormalizedTensorGraph"),
     "NormalizedTensorNode": (".snapshot", "NormalizedTensorNode"),
+    "PlotConfig": (".config", "PlotConfig"),
     "TenPyTensorNetwork": (".tenpy.explicit", "TenPyTensorNetwork"),
     "TensorComparisonConfig": (".tensor_comparison_config", "TensorComparisonConfig"),
     "TensorAnalysisConfig": (".tensor_elements_config", "TensorAnalysisConfig"),
+    "TensorDataError": (".exceptions", "TensorDataError"),
+    "TensorDataTypeError": (".exceptions", "TensorDataTypeError"),
     "TensorElementsConfig": (".tensor_elements_config", "TensorElementsConfig"),
+    "TensorNetworkDiagnosticsConfig": (".config", "TensorNetworkDiagnosticsConfig"),
+    "TensorNetworkFocus": (".config", "TensorNetworkFocus"),
     "TensorNetworkLayoutSnapshot": (".snapshot", "TensorNetworkLayoutSnapshot"),
     "TensorNetworkSnapshot": (".snapshot", "TensorNetworkSnapshot"),
+    "TensorNetworkVizError": (".exceptions", "TensorNetworkVizError"),
+    "UnsupportedEngineError": (".exceptions", "UnsupportedEngineError"),
+    "ViewName": (".config", "ViewName"),
+    "VisualizationInputError": (".exceptions", "VisualizationInputError"),
+    "VisualizationTypeError": (".exceptions", "VisualizationTypeError"),
+    "clear_tensor_network_graph_cache": ("._core.graph_cache", "clear_tensor_network_graph_cache"),
     "einsum": (".einsum_module.trace", "einsum"),
     "einsum_trace_step": (".einsum_module.trace", "einsum_trace_step"),
     "export_tensor_network_snapshot": (".snapshot", "export_tensor_network_snapshot"),