Expose an AiiDA database according to the OPTiMaDe specification.
Project description
Optimade API implementation for AiiDA
| Latest release | Build status | Activity |
|---|---|---|
   |
  |
 |
This is a RESTful API server created with FastAPI that exposes an AiiDA database according to the OPTiMaDe specification.
It is mainly used by Materials Cloud to expose access to archived AiiDA databases through the OPTiMaDe API. But it may be freely implemented by any to fulfill a similar purpose.
The server is based on the test server "template" used in the optimade-python-tools package.
Indeed, the filter grammar and parser and pydantic models from optimade-python-tools are used directly here.
Lastly, the server utilizes the FastAPI concept of routers, which means each endpoint can be "setup" several times, allowing multiple base URLs and more flexibility.
Prerequisites
Environment where AiiDA is installed.
AiiDA database containing StructureData nodes, since these are the only AiiDA nodes that are currently exposed with this API (under the /structures endpoint).
Note: At the moment,
aiida-optimadeworks most optimally with an AiiDA database using the SQLAlchemy backend.
Installation
git clone https://github.com/Materials-Consortia/optimade-python-tools
pip install -e optimade-python-tools/
git clone https://github.com/aiidateam/aiida-optimade
pip install -e aiida-optimade/
Running the server locally
# specify AiiDA profile (will use default otherwise)
export AIIDA_PROFILE=optimade
sh run.sh
Navigate to http://127.0.0.1:5000/optimade/info
Running via docker
Adapt profiles/quicksetup.json and profiles/docker-compose.yml appropriately.
docker-compose -f profiles/docker-compose.yml up --build
Navigate to http://127.0.0.1:3253/optimade/info
Stop by using
docker-compose -f profiles/docker-compose.yml down
Design choices
Q: Why create an individual config.json file instead of just mounting an existing .aiida directory and using that directly?
A: This, currently, wouldn't work because the REPOSITORY_URI needs to point to the right path inside the container, not on the host. Furthermore, storing all configurations in the same file can be fragile.
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
File details
Details for the file aiida-optimade-0.3.0.tar.gz.
File metadata
- Download URL: aiida-optimade-0.3.0.tar.gz
- Upload date:
- Size: 27.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 83dce59af9582dbfffd8f3773d2d4d219821f15175627e75bb7f938700ca7a60 |
|
| MD5 | 71763675fad56f0efd681d6ca0e9aa29 |
|
| BLAKE2b-256 | 3ccd3b67c821d14b930971dc8e1e7c54e767f61db8e2be37847b0d582504331f |
