by Hannah Pollak, Matteo Degiacomi, Valentina Erastova, University of Edinburgh, 2023

Quick start:

This package requires python version >=3.9 and pipx, and it also uses some of the functionality of Gromacs.

Install ClayCode:

gh repo clone Erastova-group/ClayCode
cd ClayCode
bash install.sh

Example usage:

ClayCode builder -f path/to/input_NAu-1-fe.yaml

Docs and Examples:

Please see ClayCode website claycode.readthedocs.io/en/latest for the Manual and Tutorials.

Future Development and Contribution:

Found a bug? or have a question? Raise an issue.

Dreaming of a new functionality? Let us know via issues, label:enhancement.

Have you added new functionality to the code, or assigned new clay unit cells? Please share with the wider community by forking this project and submitting a pull request. Learn more how to contribute here. We can only make this together!

Cite as:

Hannah Pollak, Matteo T. Degiacomi, Valentina Erastova. "ClayCode v.0.8.0" 10.5281/zenodo.11219451