diff --git a/.gitignore b/.gitignore index 5db2d62c3203717840eabbafcdbebec9fba67ca9..6b32db3c6c459493ef739c1f4115c644f95a227f 100644 --- a/.gitignore +++ b/.gitignore @@ -36,3 +36,4 @@ gui/src/searchQuantities.json examples/workdir/ gunicorn.log.conf nomad/gitinfo.py +*/node_modules/ \ No newline at end of file diff --git a/docs/developers.md b/docs/developers.md index f3e1c11fad4af0c2d9a757e6edb3970416dbfe30..30ddba73d9eee2f93b739c2baa9a364940ecdbb1 100644 --- a/docs/developers.md +++ b/docs/developers.md @@ -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 diff --git a/ops/docker-compose/nomad-oasis/README.md b/ops/docker-compose/nomad-oasis/README.md index 08a5d81a45bac2898b7da402b0705366ee4741e1..66c13e8e80259a76968b2b2664a6b395ff81076a 100644 --- a/ops/docker-compose/nomad-oasis/README.md +++ b/ops/docker-compose/nomad-oasis/README.md @@ -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>'