Skip to content

Commit 59e6745

Browse files
committed
update readme
1 parent afb4a68 commit 59e6745

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88

99
Tools for making [OPTIMADE APIs](https://optimade.org) from various formats of structural data (e.g. an archive of CIF files).
1010

11-
This repository contains the following Python packages that work towards this aim:
11+
This repository contains the `src/optimake` Python packages that work towards this aim. Features include
1212

13-
- `src/optimake`: defines a config file format for annotating archives and registered the desired OPTIMADE entries, and a workflow for ingesting them and converting into OPTIMADE types using pre-existing parsers (e.g., ASE for structures). The archive is converted into an intermediate JSONLines file format that can be ingested into a database and used to serve a full OPTIMADE API.
14-
- `src/optimade_launch`: provides a platform for launching an OPTIMADE API server
15-
from such a JSON lines file. It does so using the
16-
[`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/)
17-
reference server implementation.
13+
- definition of a config file format (`optimade.yaml`) for annotating data archives to be used in the OPTIMADE ecosystem;
14+
- conversion of the raw data into corresponding OPTIMADE types using pre-existing parsers (e.g., ASE for structures);
15+
- conversion of the annotated data archive into an intermediate JSONLines file format that can be ingested into a database and used to serve a full OPTIMADE API.
16+
- serving either an annotated data archive or a JSONLines file as an OPTIMADE API (using the [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/)
17+
reference server implementation).
1818

1919
## Usage
2020

0 commit comments

Comments
 (0)