@@ -71,6 +71,7 @@ This should return something similar to:
7171 Commands:
7272 descriptors Calculate MLIP descriptors.
7373 eos Calculate equation of state.
74+ elasticity Calculate elasticity tensors.
7475 geomopt Perform geometry optimization and save optimized structure...
7576 md Run molecular dynamics simulation, and save trajectory and...
7677 neb Run Nudged Elastic Band method.
@@ -480,6 +481,32 @@ Optimization at constant volume for all generated structures can also be perform
480481 For all options, run ``janus eos --help ``.
481482
482483
484+ Elasticity
485+ ----------
486+
487+ Calculate the elasticity tensor for a given structure (using the `MACE-MP <https://github.com/ACEsuit/mace-mp >`_ "small" force-field):
488+
489+ .. code-block :: bash
490+
491+ janus elasticity --struct tests/data/NaCl.cif --arch mace_mp
492+
493+ This will use `pymatgen <https://github.com/materialsproject/pymatgen >`_ to generate a set of deformed structures of the input structure. These
494+ are used to estimate the stress-strain relationship and thereby calculate the elasticity tensor.
495+
496+ The output, by default, is written to ```janus_results/NaCl-elastic_tensor.dat` `` containing derived values of the bulk and shear modulus in
497+ Reuss/Voigt/VRH schemes, Young's modulus, the Universal anisotropy, Homogeneous Poisson ratio, and finally the elasticty tensor in row-major
498+ (Voigt form by default). The units are GPa throughout.
499+
500+ By default 4 shear and 4 normal strains are applied. This means two positively and two negatively sheared structures in each possible direction.
501+ Which results in 4*3*2 stress calculations.
502+
503+ These can be adjusted in number and independently in magnitude. For example to use 10 shear and normal strains with maximum magnitudes 0.1
504+ and 0.02 the following command can be executed:
505+
506+ .. code-block :: bash
507+
508+ janus elasticity --struct tests/data/NaCl.cif --arch mace_mp --shear-magnitude 0.1 --normal-magnitude 0.02 --n-strains 10
509+
483510 Phonons
484511-------
485512
0 commit comments