What is mkite?
mkite is a suite of tools for running high-throughput materials simulations in distributed computing platforms. The mkite suite decouples the production database from client workers, facilitating scaling of simulations across heterogeneous computing environments. The infrastructure enables exploration of combinatorial materials spaces using workflows, recipes, data visualizations, and more.
Some advantages of mkite:
- It stores and organizes complex materials workflows on databases. For example, mkite allows creating workflows with more than one parent input branch (say, interfaces between solids and molecules).
- The server is agnostic to the computing environments where the tasks are performed, and the clients are unaware of the production database. This facilitates distributing the tasks across heterogeneous computing systems.
- It provides textual descriptions for workflows, and enables adapting them on-the-fly. This helps as a "lab notebook" for computational materials scientists.
- It is adaptable to many software packages and inputs. The recipe system also interacts well with other libraries, such as ASE, pymatgen, cclib, and more.
Documentation
General tutorial for mkite and its plugins are available in the main documentation.
Complete API documentation is pending.
Installation
To install mkite_db, first install mkite_core and mkite_engines.
Then, install this repository with pip:
pip install mkite_core mkite_engines
pip install mkite_db
Alternatively, for a development version, clone this repo and install it in editable form:
pip install -U git+https://github.com/mkite-group/mkite_db
Contributions
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.
Citing mkite
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},
}
License
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-CODE-848161
Metadata
Release files for mkite-db 25.11.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkite_db-25.11.3.tar.gz | 99.8 kB | Without provenance | Details for mkite_db-25.11.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkite_db-25.11.3-py3-none-any.whl | Python 3 | none | any | Details for mkite_db-25.11.3-py3-none-any.whl |
Total release size: 184.4 kB
Release files / mkite_db-25.11.3.tar.gz
| Download URL | mkite_db-25.11.3.tar.gz |
|---|---|
| Size | 99.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
843cf65f712e3135b85f61ed6a50c78f160f917a1f54db8ced2538236be8f27f
|
|
BLAKE2b-256 checksum How to use checksums |
abb8a02d6df6073d6250cba8d2c8405782193e61aacb553fb9927a0fb019f0eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / mkite_db-25.11.3-py3-none-any.whl
| Download URL | mkite_db-25.11.3-py3-none-any.whl |
|---|---|
| Size | 84.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
35f9fde65291ad73e6b1dd739d3f110d8d2d7d5ca077916d7be20847e91464a7
|
|
BLAKE2b-256 checksum How to use checksums |
03a2cd1cbeba11d2f4a40d22f79f980a5e161cc7cab64d490c2dd378848d233f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for mkite-db 25.11.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.