Atomic Similation Interface (ASI) API
Atomic Simulation Interface (ASI) is a native C-style API that includes functions for export and import of data structures that are used in electronic structure calculations and for classical molecular dynamics simulations. ASI aims to be a uniform, generic and efficient interface for connecting various computational chemistry and materials science codes in multiscale simulation workflows, such as QM/MM, QM/ML, QM/QM. ASI specifies functions, data types and calling conventions for export and import of density matrices, overlap and Hamiltonian matrices, electrostatic potential, atomic coordinates, charges, total energy and forces.
ASI API specification
ASI API is specified as a C header file asi.h. Codes implementing ASI API must provide linkable library with definitions of functions from asi.h. Depending on particular usage of the implementaions, some functions can be ommited or implemented as stubs, if they are not going to used. To use Python ASI wrapper it is necessary to have all functions from asi.h defined, but of course stub definitions can be used.
Supported in:
- DFTB+: in separate branch.
- FHI-aims: in the main branch.
Building
FHI-aims
FHI-aims has embedded support of ASI API. Just build latest version of FHI-aims as a shared library and use with your code.
DFTB+
-
Download and build DFTB+ from the branch with ASI API with shared library support.
-
Set environment variables
DFTBP_INCLUDEandDFTBP_LIB_DIRto folders with DFTB+ C-headers and libraries. -
Optionally export environment variables
INSTALL_PREFIXandBUILD_PATHto set installation and building locations. -
Run
make && make installfrom the root of the working copy of this repository. -
The shared library implementing ASI API for DFTB+ will be in
${INSTALL_PREFIX}/lib.
Testing
Use Makefile in tests folder to build native tests. Set environment variables in the header of tests/Makefile to link with proper ASI API implementaions.
To run tests go to tests/testcases and run run_dftbp_tests.sh or run_aims_tests.sh to run test.
Usage
See tests/src for examples of usage in native code.
See tests/python for examples of usage in Python scripts.
1 maintainer
Metadata
1 maintainer
Release files for asi4py 1.4.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| asi4py-1.4.9.tar.gz | 20.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| asi4py-1.4.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 40.0 kB
Release files / asi4py-1.4.9.tar.gz
| Download URL | asi4py-1.4.9.tar.gz |
|---|---|
| Size | 20.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a4231fc0fd6ab9660a86387486f8525422042c17a74718ea4095861ebd386931
|
|
BLAKE2b-256 checksum How to use checksums |
43dcbccc81e84bb56cee9d9e9343a1da54fbfdb5cea6eeff5df104d9386e5f77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.5
|
Release files / asi4py-1.4.9-py3-none-any.whl
| Download URL | asi4py-1.4.9-py3-none-any.whl |
|---|---|
| Size | 19.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a9c86977579ca9b735d3d6d02615d4e0f95b56f17c4e354898d06fe8a932753e
|
|
BLAKE2b-256 checksum How to use checksums |
6ee9016905b084f1b641aa576ecca1184c38ca8edf7bb117e97f987898ec436d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.5
|
