Skip to main content

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@llnl.gov.

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 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkite-db 0.1.1
File Size Uploaded Provenance Actions
mkite_db-0.1.1.tar.gz 96.6 kB Without provenance Details for mkite_db-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mkite-db 0.1.1
File Interpreter ABI Platform Actions
mkite_db-0.1.1-py3-none-any.whl Python 3 none any Details for mkite_db-0.1.1-py3-none-any.whl

Total release size: 176.9 kB

Release files / mkite_db-0.1.1.tar.gz

Download URL mkite_db-0.1.1.tar.gz
Size 96.6 kB
Tags Source
SHA-256 checksum
How to use checksums
2ccbf5e7d900dcf35ae1e3ac0cb9e3ccf3706e79393b057ccab0188915a2c783
BLAKE2b-256 checksum
How to use checksums
aee11c3556d71e793ca110f83120935a2a40d60ef91879d50dbd4aa3b94182e7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.13

Release files / mkite_db-0.1.1-py3-none-any.whl

Download URL mkite_db-0.1.1-py3-none-any.whl
Size 80.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d03bf5293400fb97f5478f605700eb2fb145037e04f8abf46d85ddf172726fb1
BLAKE2b-256 checksum
How to use checksums
00b2796923b039b87161a107336a0238c6c73bacc7aabd7470fca05d12996d22
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.13

Security for mkite-db 0.1.1

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page