Metadata-Version: 2.4
Name: casm-tools
Version: 2.0a1
Summary: CASM command line tools
Author-email: CASM developers <casm-developers@lists.engr.ucsb.edu>
License-Expression: LGPL-2.1-or-later
Project-URL: Homepage, https://prisms-center.github.io/CASMcode_docs/
Project-URL: Repository, https://github.com/prisms-center/CASMcode_tools
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: <3.14,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: libcasm-xtal>=2.2.0
Requires-Dist: libcasm-mapping>=2.2.0
Requires-Dist: libcasm-configuration>=2.2.0
Requires-Dist: numpy
Requires-Dist: tabulate
Provides-Extra: ase
Requires-Dist: ase; extra == "ase"
Dynamic: license-file

<img alt="Shows the CASM logo" src="https://raw.githubusercontent.com/prisms-center/CASMcode_global/main/python/doc/_static/logo.svg" width="600" />

#### casm-tools

The casm-tools package provides pure Python CLI tools and helper functions. This includes:

- casm-calc: Setup, run, and report results of structure calculations
- casm-map: Structure mapping and import


#### Install

    pip install casm-tools


#### Usage

See the [casm docs](https://prisms-center.github.io/CASMcode_pydocs/casm/overview/latest/).


#### Instal Zsh Completions

To install Zsh completions, cp the completions function to your custom completions directory:

    cp completions/zsh/_casm_map ~/.oh-my-zsh/custom/completions/_casm-map

Then reload your shell or run:

    compinit


#### About CASM

The casm-tools package is part of the [CASM](https://prisms-center.github.io/CASMcode_docs/) open source software package, which is designed to perform first-principles statistical mechanical studies of multi-component crystalline solids.

CASM is developed by the Van der Ven group, originally at the University of Michigan and currently at the University of California Santa Barbara.

For more information, see the [CASM homepage](https://prisms-center.github.io/CASMcode_docs/).


#### License

GNU Lesser General Public License (LGPL). Please see the file LICENSE for details.

