CLuster Expansion in Atomistic Simulation Environment


Keywords
Cluster, Expansion, Monte, Carlo, Computational, materials, research
License
MPL-2.0
Install
pip install clease==1.0.6

Documentation

CLEASE

Python GUI Average PyPI
coverage coverage coverage PyPI version

CLuster Expansion in Atomic Simulation Environment (CLEASE) is a package that automates the cumbersome setup and construction procedure of cluster expansion (CE). It provides a comprehensive list of tools for specifying parameters for CE, generating training structures, fitting effective cluster interaction (ECI) values and running Monte Carlo simulations. A detailed description of the package can be found in the user guide and our paper.

Partners and Support

image1 image2 image3

Installation

Install the CLEASE code by executing

pip install .

in the root folder of the project. If you are a developer you might want to install CLEASE by

pip install -e .

Graphical User Interface

CLEASE comes with a handy graphical user interface (GUI) that can be used to setup Cluster Expansion models. In order to use the GUI you need to install some additional packages

pip install kivy
pip install 'https://github.com/kivy-garden/graph/archive/master.zip'

There is also a convenience command for doing these two steps

clease gui-setup

To launch a GUI simply type

clease gui

on the command line.

Troubleshooting

  1. If you are running on Mac and get the error
fatal error: 'ios' file not found

try this before installing

export MACOSX_DEPLOYMENT_TARGET=10.14