https://github.com/openkim/kim-api
The Open Knowledgebase of Interatomic Models (OpenKIM) aims to be an online resource for standardized testing, long-term warehousing and easy retrieval of interatomic models and data.
https://github.com/openkim/kim-api
Last synced: about 2 months ago
JSON representation
The Open Knowledgebase of Interatomic Models (OpenKIM) aims to be an online resource for standardized testing, long-term warehousing and easy retrieval of interatomic models and data.
- Host: GitHub
- URL: https://github.com/openkim/kim-api
- Owner: openkim
- License: lgpl-2.1
- Created: 2014-07-28T21:21:08.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-09-18T23:00:58.000Z (3 months ago)
- Last Synced: 2025-10-21T20:56:58.286Z (about 2 months ago)
- Language: C++
- Homepage: https://openkim.org
- Size: 20.3 MB
- Stars: 32
- Watchers: 8
- Forks: 19
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS
- License: LICENSE.LGPL
Awesome Lists containing this project
- best-of-atomistic-machine-learning - GitHub - 40% open · ⏱️ 29.04.2025): (Datasets)
README
[](https://github.com/openkim/kim-api/actions/workflows/build-multiplatform.yml)
[](https://kim-api.readthedocs.io/en/master/?badge=master)
[](https://scan.coverity.com/projects/openkim-kim-api)
[](https://codecov.io/gh/openkim/kim-api/branch/master)
The KIM API package
The KIM API package is a system-level library that aims to give computer
programmers the ability to write atomistic or molecular simulation programs
that can seamlessly interface with implementations of interatomic models,
regardless of the programming language (C, C++, Fortran, Python, etc.) in which
the codes are written. It is part of the larger KIM project
(https://openkim.org).
Documentation
-------------
[Full documentation](https://kim-api.readthedocs.io/en/master) is available online via [readthedocs.org](https://readthedocs.org)
Download
--------
All official release archives of the KIM API package can be downloaded from:
[https://openkim.org/kim-api/previous-versions](https://openkim.org/kim-api/previous-versions)
Release notes are available in the [NEWS](NEWS) file.
Installation
------------
See the [INSTALL](INSTALL) file for instructions on how to build and install
the package and its documentation.
Contributing
------------
Just send us a [pull request](https://help.github.com/articles/using-pull-requests/).
When you send your request, make `devel` the destination branch on the
[kim-api repository](https://github.com/openkim/kim-api).
Please see the [README_GIT](README_GIT) file for some additional details.
Issues, bugs, requests, ideas
-----------------------------
Use the [issues](https://github.com/openkim/kim-api/issues) tracker to report
bugs.
License
-------
The KIM API is distributed under the terms of the LGPL-2.1-or-later
license.
All new contributions must be made under this license.
See [LICENSE.LGPL](LICENSE.LGPL) and
[https://spdx.org/licenses/LGPL-2.1-or-later.html](https://spdx.org/licenses/LGPL-2.1-or-later.html)
for details.
*******************************************************************************
SUPPORT
Support is always available by posting questions with all relevant information
to
Members of the OpenKIM development team actively monitor this forum and
will do their best to respond to questions in a timely fashion.
*******************************************************************************