Commit 1f9eeeba authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Documentation fixes.

parent 9c6f6c7b
Pipeline #95382 passed with stages
in 28 minutes and 13 seconds
......@@ -36,3 +36,4 @@ gui/src/searchQuantities.json
examples/workdir/
gunicorn.log.conf
nomad/gitinfo.py
*/node_modules/
\ No newline at end of file
......@@ -76,6 +76,10 @@ everything into your virtual environment:
./dependencies.sh -e
```
If one of the Python packages that are installed during this process, fails because it
cannot be compiled on your platform, you can try `pip install --prefer-binary <packagename>`
to install set package manually.
The `-e` option will install the NOMAD-coe dependencies with symbolic links allowing you
to change the downloaded dependency code without having to reinstall after.
......@@ -134,11 +138,20 @@ via your preferred tools. Just make sure to use the right ports.
## Running NOMAD
NOMAD consist of the NOMAD app/api, a worker, and the GUI. You can run app and worker with
the NOMAD cli:
the NOMAD cli. These commands will run the services and show their logout put. You should open
them in separate shells as they run continuously. They will not watch code changes and
you have to restart manually.
```sh
nomad admin run app
```
```sh
nomad admin run worker
```
Or both together in once process:
```
nomad admin run appworker
```
......@@ -150,7 +163,9 @@ celery -A nomad.processing worker -l info
```
When you run the gui on its own (e.g. with react dev server below), you have to have
the app manually also.
the app manually also. The gui and its dependencies run on [node](https://nodejs.org) and
the [yarn](https://yarnpkg.com/) dependency manager. Read their documentation on how to
install them for your platform.
```sh
cd gui
yarn
......
......@@ -183,6 +183,7 @@ client:
url: 'http://<your-host>/nomad-oasis/api'
services:
api_host: '<your-host>'
api_prefix: '/nomad-oasis'
admin_user_id: '<your admin user id>'
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment