Metadata-Version: 2.4
Name: tce-lib
Version: 0.11.1
Summary: tensor cluster expansion library for solid solution modeling
Project-URL: Homepage, https://github.com/MUEXLY/tce-lib
License-Expression: MIT
License-File: LICENSE
Keywords: alloys,ase,cluster expansion,density functional theory,machine learning,materials science,monte carlo,scientific computing
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: aenum<3.1.17,>=3.0.0
Requires-Dist: ase<3.26.0,>=3.10.0
Requires-Dist: numpy<3.0,>=2.0.0
Requires-Dist: opt-einsum<4.0,>=3.0.1
Requires-Dist: scipy<1.16.0,>=1.6.0
Requires-Dist: sparse<0.17.0,>=0.14.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-cov~=7.0.0; extra == 'dev'
Requires-Dist: pytest~=8.0.2; extra == 'dev'
Requires-Dist: ruff~=0.9.4; extra == 'dev'
Requires-Dist: scikit-learn-stubs~=0.0.3; extra == 'dev'
Requires-Dist: scikit-learn~=1.7.1; extra == 'dev'
Requires-Dist: scipy-stubs~=1.15.3.0; extra == 'dev'
Provides-Extra: examples
Requires-Dist: cowley-sro-parameters~=1.1.1; extra == 'examples'
Requires-Dist: ovito~=3.13.1; extra == 'examples'
Requires-Dist: requests~=2.32.5; extra == 'examples'
Requires-Dist: scikit-learn~=1.7.1; extra == 'examples'
Description-Content-Type: text/markdown

# tce-lib

<p align="center">
  <a href="https://muexly.github.io/tce-lib">
    <img src="https://img.shields.io/badge/docs-orange?logo=github&logoColor=green&label=gh-pages" style="height: 48px;" alt="Documentation Website">
  </a>
</p>

<hr>

<p align="left">
  <a href="https://pypi.org/project/tce-lib/"><img src="https://img.shields.io/pypi/v/tce-lib?color=blue" style="height: 22px;" alt="Stable Version"></a>
  <a href="https://en.wikipedia.org/wiki/MIT_License"><img src="https://img.shields.io/badge/License-MIT-8A2BE2" style="height: 22px;" alt="Static Badge"></a>
  <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" style="height: 22px;" alt="Linting: Ruff"></a>
  <a href="https://mypy-lang.org/"><img src="https://www.mypy-lang.org/static/mypy_badge.svg" style="height: 22px;" alt="Checked with mypy"></a>
  <a href="https://docs.pytest.org/en/stable/"><img src="https://img.shields.io/badge/pytest-tested-blue?logo=pytest" style="height: 22px;" alt="Tested with pytest"></a>
  <a href="https://deepwiki.com/MUEXLY/tce-lib"><img src="https://deepwiki.com/badge.svg" style="height: 22px;" alt="Ask DeepWiki"></a>
</p>

<img src="https://raw.githubusercontent.com/MUEXLY/tce-lib/refs/heads/main/assets/logo.png" alt="tce-lib logo" style="width:50%;height:auto;">


## 🔎 What is tce-lib?

`tce-lib` is a library for creating and deploying tensor cluster expansion models of concentrated alloys following
our work on [arXiv](https://arxiv.org/abs/2509.04686). The core philosophy of `tce-lib` is to respect the 
[strategy pattern](https://en.wikipedia.org/wiki/Strategy_pattern) as core to the library's functionality. This design
pattern stages workflows as sequences of strategies, of which the user can override each. This allows for the majority 
of users to plug-and-play for an ordinary workflow, while still supporting fine-grained autonomy for more advanced 
users. 

## 📩 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://www.sciencedirect.com/science/article/pii/S0927025625006810) 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.
