Repository containing the Area C specific documentation for using NOMAD for computational data.
We organized the information in correlated sections:
In the workflow-documentation directory, create your own virtual environment with Python3.9:
python3 -m venv .pyenvdoc
and activate it in your shell:
. .pyenvdoc/bin/activate
Make sure you have the latest pip version:
pip install --upgrade pip
Pip-install the requirements.txt
file:
pip install -r requirements.txt
Launch locally:
mkdocs serve
The output on the terminal should have these lines:
...
INFO - Building documentation...
INFO - Cleaning site directory
INFO - Documentation built in 0.29 seconds
INFO - [14:31:29] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO - [14:31:29] Serving on http://127.0.0.1:8000/
...
Then click on the http address to launch the MKDocs.