A latticegas MonteCarlo simulation tool
Project description
lattice_mc: A Python LatticeGas Monte Carlo Module
lattice_mc
is Python module for performing (kinetic) latticegas Monte Carlo (LGMC) simulations of ionic transport in solid electrolytes.
In solid electrolytes, ionic motion is typically effected by a series of discrete “jumps” where ions move between adjacent lattice sites [1]. For dilute mobile ions, ionic trajectories are random walks, and simple analytical expressions exits that relate macroscopic transport coefficients, i.e. diffusion coefficients and ionic conductivities, to the microscopic jump frequency of individual ions [2,3]. Practical solid electrolytes have high mobile ion concentrations, with significant interparticle interactions producing deviations from the dilute limit random walk behaviour. In general, the quantitative effect of interparticle interactions cannot be determined analytically. As an alternative, numerical simulations, such as latticegas Monte Carlo methods, can be used to directly calculate these relationships. Latticegas Monte Carlo methods are particularly suited to studying how varying properties across broad classes of materials give quantitative differences in macroscopic ionic transport, and can be used to understand the different transport properties of materials with, for example, different crystal structures or mobile ion stoichiometries.
lattice_mc
has been written to allow materials scientists and solidstate chemists model how the microscopic physics of solid electrolytes (crystal structure, stoichiometry, interaction models) determine macroscopic transport behaviour (diffusion and ionic conduction), with the goal of understand the factors that make different materials more or less useful for specific applications (e.g. Liion batteries or fuel cells).
The code allows the programmatic construction of simple lattices (presently implemented are square, honeycomb, and cubic lattices). Lattices with arbitrary geometries can be constructed from a file format that defines the lattice sites and their connectivity, allowing models based on crystallographic data. The algorithms used and interaction models are described in more detail in Ref. [4]. Calculated properties include tracer and “jump” diffusion coefficients; where the latter is proportional to the mobility (and hence the conductivity for charged particles) [5]; and tracer (single particle) and collective correlation factors, f and f_{I} [6]. The simplest interaction model is for “noninteracting” particles, where the only restriction is volume exclusion (two particles cannot simultaneously occupy a single site) [7]. Additional interaction models include nearestneighbour repulsion and onsite energies for inequivalent sites. Simulations are performed using an efficient rejectionfree Monte Carlo scheme [8].
Installation
pip install lattice_mc
Or download the latest release from GitHub
https://github.com/bjmorgan/lattice_mc/archive/1.0.0.tar.gz
Then install
cd lattice_mc
python setup.py install
Or you can clone the latest development version:
git clone git@github.com:bjmorgan/lattice_mc.git
and install the same way.
cd lattice_mc
python setup.py install
Alternatively, you can install the latest build using pip
, direct from GitHub, e.g.
pip3 install git+https://github.com/bjmorgan/lattice_mc.git
Documentation
Full documentation and examples are contained in a Jupyter notebook at examples/lattice_mc_example.ipynb. The example notebook is also hosted on GitHub.
Tests
Automated testing of the latest build happens here.
Manual tests can be run using
python3 m unittest discover
The code has been tested with Python versions 3.5 and above.
References
 C. R. A. Catlow, Sol. Stat. Ionics 8, 89 (1983).
 R. E. Howard and A. B. Lidiard, Rep. Prog. Phys. 27, 161 (1964).
 J. H. Harding, Defects and Transport in Ionic Solids, in Ionic Solids at High Temperatures ed. A. M. Stoneham, World Scientific (1989).
 B. J. Morgan, arXiv: 1707.00491
 A. Van der Ven et al. Acc. Chem. Res. 46, 1216 (2013).
 G. E. Murch Sol. Stat. Ionics 7, 177 (1982).
 R. Kutner Phys. Lett. 81A, 239 (1981).
 A. F. Voter, Introduction to the Kinetic Monte Carlo Method, in Radiation Effects in Solids, ed. K. E. Sicafus et al., Springer (2007).
 Morgan and Madden, J. Phys. Condens. Matter 24, 275303 (2012).
 G. E. Murch & R. J. Thorn, Phil. Mag. 36 529 (1977).
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size  File type  Python version  Upload date  Hashes 

Filename, size lattice_mc1.0.4py3noneany.whl (23.1 kB)  File type Wheel  Python version py3  Upload date  Hashes View 
Filename, size lattice_mc1.0.4.tar.gz (17.1 kB)  File type Source  Python version None  Upload date  Hashes View 
Hashes for lattice_mc1.0.4py3noneany.whl
Algorithm  Hash digest  

SHA256  9e710ce1c6e03edce37045905b8942bae2592663ccdf3db40c9dd83e2b9cba9b 

MD5  cf844251534c7b423e691eb36ad50501 

BLAKE2256  a86517b1b4dd823943ec17ba4887609579f63a549f3d52017863882fa1d37405 