Merge branch 'main' into nick/fortran_ordering

Author: dmdunla

CHANGELOG.md

@@ -1,3 +1,12 @@
+# v1.8.2 (2025-01-06)
+- Fixed:
+    - Fixed layout and printing issues (https://github.com/sandialabs/pyttb/pull/354)
+    - Fixed tutorial hierarchy (https://github.com/sandialabs/pyttb/pull/343)
+- Improved:
+    - Improved `pyttb_utils` (https://github.com/sandialabs/pyttb/pull/353)
+    - Improved docs for coming from MATLAB (https://github.com/sandialabs/pyttb/pull/352)
+    - Improved shape support in data classes (https://github.com/sandialabs/pyttb/pull/348)
+
 # v1.8.1 (2024-11-11)
 - Fixed: 
   - Aligning comparison operator output for data classes (https://github.com/sandialabs/pyttb/pull/331)

CITATION.bib

@@ -1,7 +1,7 @@
 @misc{pyttb,
 	author = {Dunlavy, Daniel M. and Johnson, Nicholas T. and others},
-	month = nov,
-	title = {{pyttb: Python Tensor Toolbox, v1.8.1}},
+	month = jan,
+	title = {{pyttb: Python Tensor Toolbox, v1.8.2}},
 	url = {https://github.com/sandialabs/pyttb},
-	year = {2024}
+	year = {2025}
 }

docs/source/matlab/ktensor.rst

@@ -22,7 +22,5 @@ Methods
 +-----------------+----------------------+------------------------------------------------------------------------+
 | ``tensor``      | ``to_tensor``        | ``X.to_tensor()``                                                      |
 +-----------------+----------------------+------------------------------------------------------------------------+
-
-MATLAB methods not included in ``pyttb``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-* ``viz``
+| ``viz``         | ``viz``              | ``X.viz()``                                                            |
++-----------------+----------------------+------------------------------------------------------------------------+

pyttb/__init__.py

@@ -6,7 +6,7 @@
 
 from __future__ import annotations
 
-__version__ = "1.8.1"
+__version__ = "1.8.2"
 
 
 import warnings

pyttb/ktensor.py

@@ -2250,7 +2250,7 @@ def update(self, modes: OneDArray, data: np.ndarray) -> ktensor:
 
         return self
 
-    def vis(  # noqa: PLR0912, PLR0913
+    def viz(  # noqa: PLR0912, PLR0913
         self,
         plots: Optional[Union[tuple, list]] = None,
         show_figure: bool = True,
@@ -2319,9 +2319,9 @@ def vis(  # noqa: PLR0912, PLR0913
         >>> np.random.seed(1)
         >>> K = ttb.ktensor.from_function(np.random.random_sample, (2, 3, 10), 2)
 
-        Use plot K using default behavior K.vis()
+        Use plot K using default behavior K.viz()
 
-        >>> fig, axs = K.vis(show_figure=False)  # doctest: +ELLIPSIS
+        >>> fig, axs = K.viz(show_figure=False)  # doctest: +ELLIPSIS
         >>> plt.close(fig)
 
         Define a more realistic plot functions with x labels,
@@ -2338,7 +2338,7 @@ def vis(  # noqa: PLR0912, PLR0913
         ...     ax.semilogx(np.logspace(-2, 2, v.shape[0]), v)
         ...     ax.set_xlabel("$E$, [kJ]")
         >>> plots = [mode_1_plot, mode_2_plot, mode_3_plot]
-        >>> fig, axs = K.vis(
+        >>> fig, axs = K.viz(
         ...     show_figure=False,
         ...     plots=plots,
         ...     rel_widths=[1, 2, 3],