Metadata-Version: 2.1
Name: pyttb
Version: 1.8.0
Summary: Python Tensor Toolbox
Author-email: "Daniel M. Dunlavy" <dmdunla@sandia.gov>
License: BSD 2-Clause License
Project-URL: homepage, https://github.com/sandialabs/pyttb
Project-URL: coverage, https://coveralls.io/github/sandialabs/pyttb
Project-URL: documentation, https://pyttb.readthedocs.io
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<2
Requires-Dist: numpy-groupies
Requires-Dist: scipy
Requires-Dist: matplotlib
Provides-Extra: dev
Requires-Dist: black[jupyter]; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: nbstripout; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff==0.0.284; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Provides-Extra: doc
Requires-Dist: sphinx>=4.0; extra == "doc"
Requires-Dist: sphinx-rtd-theme; extra == "doc"
Requires-Dist: myst-nb; extra == "doc"
Provides-Extra: profiling
Requires-Dist: gprof2dot; extra == "profiling"
Requires-Dist: graphviz; extra == "profiling"

```
Copyright 2022 National Technology & Engineering Solutions of Sandia,
LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the
U.S. Government retains certain rights in this software.
```
[![Regression tests](https://github.com/sandialabs/pyttb/actions/workflows/regression-tests.yml/badge.svg)](https://github.com/sandialabs/pyttb/actions/workflows/regression-tests.yml)
[![Coverage Status](https://coveralls.io/repos/github/sandialabs/pyttb/badge.svg?branch=main)](https://coveralls.io/github/sandialabs/pyttb?branch=main)
[![pypi package](https://img.shields.io/pypi/v/pyttb?label=pypi%20package)](https://pypi.org/project/pyttb/)
[![image](https://img.shields.io/pypi/pyversions/pyttb.svg)](https://pypi.python.org/pypi/pyttb)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# pyttb: Python Tensor Toolbox

Welcome to `pyttb`, a set of Python classes and methods functions for 
manipulating dense, sparse, and structured tensors, along with algorithms 
for computing low-rank tensor models.

**Tensor Classes:**
* `tensor`: dense tensors
* `sptensor`: sparse tensors
* `ktensor`: Kruskal tensors
* `tenmat`: matricized tensors
* `ttensor`: Tucker tensors

**Tensor Algorithms:**
* `cp_als`, `cp_apr`: Canonical Polyadic (CP) decompositions
* `tucker_als`: Tucker decompostions

# Getting Started
For full details see our [documentation](https://pyttb.readthedocs.io).
## Quick Start
We are on pypi
```commandline
pip install pyttb
```
or install from source
```commandline
pip install .
```

# Contributing
Check out our [contributing guide](CONTRIBUTING.md).
