ipcamit / 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.

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 is available online via readthedocs.org

Download

All official release archives of the KIM API package can be downloaded from:

https://openkim.org/kim-api/previous-versions

Release notes are available in the NEWS file.

Installation

See the INSTALL file for instructions on how to build and install the package and its documentation.

Contributing

Just send us a pull request. When you send your request, make devel the destination branch on the kim-api repository.

Please see the README_GIT file for some additional details.

Issues, bugs, requests, ideas

Use the 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 and 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

https://matsci.org/openkim

Members of the OpenKIM development team actively monitor this forum and will do their best to respond to questions in a timely fashion.

---