Skip to content

Commit

Permalink
Make chores
Browse files Browse the repository at this point in the history
  • Loading branch information
blokhin committed Jul 26, 2023
1 parent 4d8afef commit 08ce843
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

**This is the third part of the whole Metis infra: [GUI](https://github.com/basf/metis-gui) ⇄ [BFF](https://github.com/basf/metis-bff) ⇄ [backend](https://github.com/basf/metis-backend).**


### Requirements

The basic requirements are **Python**, **Numpy**, and **Postgres**. Note that the Numpy depends on the low-level Fortran numeric system libraries, which might be absent in your system.
Expand All @@ -16,6 +17,7 @@ Thus, `metis-backend` consists of the 3 independent parts, each using Postgres:

Optionally, a frontend server is **Nginx** (`conf/nginx.conf` goes to `/etc/nginx`), and all these guys are controlled by the **Supervisor** daemon (`conf/supervisord.conf` goes to `/etc/supervisor`).


## Installation

Refer to `conf/install.sh` for installation of Nginx, Postgres, RabbitMQ, and Supervisor, as well as configuring them. Run `conf/install.sh` and then modify global options `conf/env.ini`. Alternatively, feel free to install each component on your own (or all together in a container, see below).
Expand All @@ -39,6 +41,7 @@ Then setup your virtual env, if needed, and install the Python requirements as s

Finally, apply the database schema: `/data/pg/bin/psql -U postgres -d metis -f schema/schema.sql`.


## Running

Run `supervisorctl status` to see (almost) all the services in Supervisor.
Expand All @@ -52,6 +55,7 @@ One by one, all the parts are managed as follows:
- Postgres database(s) can be seen with `/data/pg/bin/psql -U postgres -l`
- RabbitMQ is controlled with `rabbitmqctl status`


## Run in containers

This is an experimental feature intended primarily for development and testing.
Expand All @@ -67,6 +71,25 @@ directory. This should start all dependencies and services.

`metis-bff` should be available at `http://localhost:3000/`


## Recognized data formats


### Crystalline structures

- CIF
- POSCAR
- Optimade JSON


### XRPD data

- XY patterns (TSV-alike)
- Bruker's RAW (*binary*)
- Bruker's Topas CLI
- Synchrotron HDF5 (*binary*)


## License

Copyright 2021-2023 BASF SE
Expand Down
4 changes: 3 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ unidecode

pyparsing <= 2.4.7
cython # NB might be required beforehand
matplotlib >= 3.7.2
numpy
scipy
ase
pycodcif
spglib
yascheduler >= 1.0.10
yascheduler >= 1.0.12
xylib-py

0 comments on commit 08ce843

Please sign in to comment.