From 736d0d12d3fe6d13b6a59bd8f35c266de8da7ee9 Mon Sep 17 00:00:00 2001 From: Tammy Kolda Date: Thu, 20 Mar 2025 14:42:44 -0700 Subject: [PATCH] Address issues #393, #394, #395, #396 --- docs/source/index.rst | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 4a5ec16a..930010c1 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,16 +4,30 @@ pyttb: Python Tensor Toolbox **************************** Tensors (also known as multidimensional arrays or N-way arrays) are used in a variety of applications ranging from chemometrics to network -analysis. +analysis. -- Install the latest release from pypi (``pip install pyttb``). -- This is open source software. Please see `LICENSE`_ for the +- This Python package is an adaptation of the open source `Tensor Toolbox for MATLAB `_. +- This is open source software. Please see `LICENSE `_ for the terms of the license (2-clause BSD). +- The pyttb code repository is hosted at `github `_. +- Contributions are welcome; see `CONTRIBUTING `_. +- Reports of bugs and feature requests can be `submitted on github `_. - For more information or for feedback on this project, please `contact us`_. .. _`LICENSE`: ../../../LICENSE .. _contact us: #contact + +Installing +========== + +* Via pypi + - Install the latest release from pypi (``pip install pyttb`` or ``python -m pip install pyttb``) +* From source + - Clone the repository from `github `_. + - Install the package with ``pip install .`` from the pyttb root directory. + - Note: Use ``pip install -e ".[dev,doc]"`` if you are planning development. + Functionality ============== pyttb provides the following classes and functions