Metadata-Version: 2.4
Name: tce-lib
Version: 0.0.1
Summary: tensor cluster expansion
Project-URL: Homepage, https://github.com/MUEXLY/tce-lib
License-Expression: MIT
License-File: LICENSE
Keywords: alloys
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Requires-Dist: numpy~=2.0.2
Requires-Dist: opt-einsum~=3.4.0
Requires-Dist: scipy~=1.13.1
Requires-Dist: sparse~=0.16.0
Provides-Extra: dev
Requires-Dist: hatchling~=1.27.0; extra == 'dev'
Requires-Dist: mypy~=1.13.0; extra == 'dev'
Requires-Dist: pdoc~=15.0.1; extra == 'dev'
Requires-Dist: pytest~=8.0.2; extra == 'dev'
Requires-Dist: ruff~=0.9.4; extra == 'dev'
Requires-Dist: scipy-stubs~=1.15.3.0; extra == 'dev'
Provides-Extra: examples
Requires-Dist: ase~=3.26.0; extra == 'examples'
Description-Content-Type: text/markdown

# tce-lib

Library for building a tensor cluster expansion

[![Custom shields.io](https://img.shields.io/badge/docs-brightgreen?logo=github&logoColor=green&label=gh-pages)](https://muexly.github.io/tce-lib)

## 🔎 What is tce?

Placeholder text

## 📩 Installation

`tce-lib` is installable via the Python Package Index:

```shell
pip install tce-lib
```

or, from source:

```shell
git clone https://github.com/MUEXLY/tce-lib
pip install -e tce-lib/
```

## 📌 Citation

Please cite our work [here](https://google.com/) if you use `tce-lib` in your work.

## 💙 Acknowledgements

Authors acknowledge support from the U.S. Department of Energy, Office of Basic Energy Sciences, Materials Science and Engineering Division under Award No. DE-SC0022980.

## 🐝 Found a bug?

Please open an issue [here](https://github.com/MUEXLY/tce/issues), with a description of the issue and a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the issue.

## 📑 License

`tce-lib` is released under the MIT license
