Skip to content

Commit f2bfc25

Browse files
eimrekml-evs
authored andcommitted
docs: update materials cloud use case
1 parent 55185bf commit f2bfc25

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

docs/getting_started/use_cases.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,12 @@ The [Materials Project](https://materialsproject.org) uses `optimade-python-tool
66

77
`optimade-python-tools` handles filter parsing, database query generation and response validation by running the reference server implementation with minimal configuration.
88

9-
[*odbx*](https://odbx.science), a small database of results from crystal structure prediction calculations, follows a similar approach.
9+
[_odbx_](https://odbx.science), a small database of results from crystal structure prediction calculations, follows a similar approach.
1010
This implementation is open source, available on GitHub at [ml-evs/odbx.science](https://github.com/ml-evs/odbx.science).
1111

1212
## Serving multiple databases
1313

14-
[Materials Cloud](https://materialscloud.org) uses `optimade-python-tools` as a library to provide an OPTIMADE API entry to archived computational materials studies, created with the [AiiDA](https://aiida.net) Python framework and published through their archive.
15-
In this case, each individual study and archive entry has its own database and separate API entry.
16-
The Python classes within the `optimade` package have been extended to make use of AiiDA and its underlying [PostgreSQL](https://postgresql.org) storage engine.
17-
18-
Details of this implementation can be found on GitHub at [aiidateam/aiida-optimade](https://github.com/aiidateam/aiida-optimade).
14+
[Materials Cloud](https://materialscloud.org) uses `optimade-python-tools` as a library to provide an OPTIMADE API entries to 1) their main databases create with the [AiiDA](https://aiida.net) Python framework; and 2) to user-contributed data via the Archive platform. Separate OPTIMADE API apps are started for each database, mounted as separate endpoints to a parent FastAPI instance. For converting the underying data to the OPTIMADE format, the [optimade-maker](https://github.com/materialscloud-org/optimade-maker) toolkit is used.
1915

2016
## Extending an existing API
2117

0 commit comments

Comments
 (0)