Commit 3df8ce3f authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Updated oasis documentation.

parent 560acbaf
Pipeline #88767 passed with stages
in 23 minutes and 38 seconds
......@@ -340,7 +340,7 @@ If you want to report problems with your OASIS. Please provide the logs for
### Pre-requisites
We will run NOMAD from the *nomad-lab* Python package. This package contains all the necessary
code for running the processing, api, and gui. But, it is missing the necessary databases. You might be
code for running the processing, api, and gui. But, it is missing the necessary databases. You might be
able to run NOMAD in user space.
You will need:
......@@ -354,15 +354,19 @@ You will need:
### Install the NOMAD Python package
You should install everything in a virtual environment. For example like this:
```sh
virtualenv -p `which python3` nomadpyenv
source nomadpyenv/bin/activate
```
You can simply install the Python package from pypi:
```sh
pip install nomad-lab[all]
```
If you need the latest version, you can also download the latest package from our
"beta" installation.
```sh
curl "https://nomad-lab.eu/prod/rae/beta/dist/nomad-lab.tar.gz" -o nomad-lab.tar.gz
pip install nomad-lab.tar.gz[all]
......@@ -370,6 +374,8 @@ pip install nomad-lab.tar.gz[all]
### Configure NOMAD - nomad.yaml
The `nomad.yaml` is our central config file. You should write a `nomad.yaml` like this:
```yaml
client:
url: 'http://<your-host>/nomad-oasis/api'
......
Supports Markdown
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