A Python wrapper for Atomic Simulation Interface API
Project description
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file asi4py-1.3.17.tar.gz.
File metadata
- Download URL: asi4py-1.3.17.tar.gz
- Upload date:
- Size: 17.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b4291623eef859ec00229c8355b1e069373b2ae68bc4fae1f5d8f853edae3074
|
|
| MD5 |
69362c861c3bcf0ba08b990447537a96
|
|
| BLAKE2b-256 |
d6df8ff9170893dbbf18e974e343a1fb842583ce99bdb15fb931043e5dac5d93
|
File details
Details for the file asi4py-1.3.17-py3-none-any.whl.
File metadata
- Download URL: asi4py-1.3.17-py3-none-any.whl
- Upload date:
- Size: 17.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3516498365b3fd6c783954b4a3fa7af1dbb04d4fcd99048102a6cb0288738367
|
|
| MD5 |
47c5cedd95050fb04401bf5f19143696
|
|
| BLAKE2b-256 |
61cd36fc3351f3cec06f84ee9bd5eb1360bfa18fd61264a13a244fb30e711694
|
