kim-tools
KIMTestDriver and SingleCrystalTestDriver classes for creating OpenKIM Test Drivers, and helper routines for writing KIM Tests and Verification Checks. Documentation at https://kim-tools.readthedocs.io.
Contributing Guide (Under Construction)
All contributed functions, classes and methods should be documented with Google style docstrings (https://google.github.io/styleguide/pyguide.html#383-functions-and-methods) and should have type hints for all arguments and return values (https://docs.python.org/3/library/typing.html). The docstrings are automatically rendered into the API documentation. To check that this is working correctly, install the Python packages in docs/requirements-docs.txt and run make html in docs/. There are some warnings, but there should be no errors, and the rendered docstring in the appropriate module html (e.g., docs/build/html/kim_tools.ase.html) should have a properly rendered section for the functions, classes and methods you wrote. See kim_tools/test_driver/core.py for a variety of examples of docstrings.
The code has a simple test suite using pytest. See the various files named test_* in tests/ for examples and add tests for any code you write.
To confirm that your code will pass the linter and style checks, install pre-commit as in this guide: https://pre-commit.com/#quick-start. The checks will run every time you make a commit.
kim_tools/ase contains utility functions that can be used for interatomic calculations. It is inherited from merging https://github.com/openkim/kim-python-utils into this repo. Previously, it worked only with KIM Models. All new functions added to this module should support being passed both a KIM Model as a string, and an ASE Calculator object. See kim-tools/ase/core.py::get_isolated_energy_per_atom for an example. If you are working on or with existing functions in this module, try to upgrade it to this functionality.
1 maintainer
Release files for kim-tools 0.4.15
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| kim_tools-0.4.15.tar.gz | 923.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kim_tools-0.4.15-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.9 MB
Release files / kim_tools-0.4.15.tar.gz
| Download URL | kim_tools-0.4.15.tar.gz |
|---|---|
| Size | 923.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7fcb416691007c690699feadf22db4122e3a367eb9e271300a3c83efd6741b23
|
|
BLAKE2b-256 checksum How to use checksums |
669e55963dd0c00392e41cb5cbe218f4e6ef76d77ce4e5eb2e9a483fcb8f33f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 31, 2026.
Transparency logRelease files / kim_tools-0.4.15-py3-none-any.whl
| Download URL | kim_tools-0.4.15-py3-none-any.whl |
|---|---|
| Size | 2.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7f965449943935eeb92de0eb816ad490035583874a95be8541339682227abf42
|
|
BLAKE2b-256 checksum How to use checksums |
4e37aabd1abd707177123679e99dc86a98dcd6646783fc00f463ed2b88934e5c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 31, 2026.
Transparency log
