mkite_docs
has all the content for the main mkite tutorial and documentation, available at https://mkite.org.
To develop the documentation, create a fork and clone this Github repo. Then, install all the requirements for the package using
pip install -r requirements.txt
To compile the documentation as HTML, simply run the following command in the repository root (with your environment activated):
make html
Contributions to the entire mkite suite are welcomed. You can send a pull request or open an issue for this plugin or either of the packages in mkite. When doing so, please adhere to the Code of Conduct in the mkite suite.
The mkite package was created by Daniel Schwalbe-Koda dskoda@ucla.edu.
If you use mkite in a publication, please cite the following paper:
@article{mkite2023,
title = {mkite: A distributed computing platform for high-throughput materials simulations},
author = {Schwalbe-Koda, Daniel},
year = {2023},
journal = {arXiv:2301.08841},
doi = {10.48550/arXiv.2301.08841},
url = {https://doi.org/10.48550/arXiv.2301.08841},
arxiv={2301.08841},
}
The mkite suite is distributed under the following license: Apache 2.0 WITH LLVM exception.
All new contributions must be made under this license.
SPDX: Apache-2.0, LLVM-exception
LLNL-WEB-848349
LLNL-CODE-848161