ezSCUP: SCALE-UP made easy.

ezSCUP is a Python module designed to facilitate the execution of SCALE-UP simulations in a parameter grid of temperatures, pressures, strains and/or electric fields. It provides a high-level interface to handle the program and its output, includes several analysis functions concerning structural modes and macroscopic polarization in perovskites.

SCALE-UP (short for Second-principles Computational Approach for Lattice and Electrons) is a Second-Principles DFT simulation program written in Fortran and developed by researchers from the University of Cantabria (UC, Spain) and the Luxembourg Institute of Science and Technology (LIST), as well as by a number of collaborators [+info].

This module has been developed as an integral part of my Bachelor's final-year thesis on structural transititions within strontium titanate (SrTiO3), a perovskite oxide. Therefore, many of the functions in this package are designed specifically towards this structure (everything within "perovskite.py").

Features

• Schedule simulation runs in a grid of temperatures, strains, pressures and electric fields.
• Set starting geometries for each simulation run: simulate everything sequentially or independently.
• Easy output access and management for each configuration through a Python interface
• Generate an equilibrium geometry for each Monte Carlo simulation.
• Allows for the projection of structural modes (i.e. AFD or FE modes) onto said equilibrium geometry.
• Calculation of macroscopic polarization through the use of Born effective charges.
• Observe domain structures through a per-unit-cell application of the two previous features.

Installation

Although the package may be installed with a simple command (pip3 install ezSCUP), it is advisable to download the source code and place the "ezSCUP" folder in your working directory, so as to always have the most up-to-date version of the code and an easier access to it in case any modifications are needed.

Usage

The source code itself is heavily documented, so as to be almost self explanatory. Working examples may be found in the "examples" folder, corresponding to several use cases explored in my thesis. The simulation settings (number of MC steps, supercell size) have been tuned down in order to fit the whole simulation run in a few hours, as opposed to the several weeks it took in the original work. Explanations on each different setup may be found within the corresponding folder, although I must note that the SrTiO3 model used in these examples, as well as in the "tests" folder, corresponds to the one used by Wojdeł et al. in this article.

Representation of the antiferrodistortive phase transition present in bulk SrTiO3 simulated with ezSCUP,
using 8x8x8 and 10x10x10 supercells with 40,000-80,000 MC steps per simulation.