install.rst 1.21 KB
Newer Older
1
2
3
4
5
6
Install the NOMAD client library
================================

We release the NOMAD client library as a Python `distutils <https://docs.python.org/3/library/distutils.html>`_ source distribution.
You can install it the usual way using *pip* (or *conda*).

Markus Scheidgen's avatar
Markus Scheidgen committed
7
.. parsed-literal::
8

Markus Scheidgen's avatar
Markus Scheidgen committed
9
    pip install nomad --extra-index-url |pypi_url|
10
11
12
13
14
15
16
17
18
19

There are different layers of dependencies that you have to install, in order to use
certain functions of NOMAD. The base install above, will only install the
necessary packages for accessing the NOMAD Archive and use the NOMAD metainfo (see
:ref:`access the archive <access-the-archive-label>`).

Other functions, e.g. using the NOMAD parsers to parse your code output, require
additional dependencies. You can use the ``[extra]`` notation to install these extra
requirements:

Markus Scheidgen's avatar
Markus Scheidgen committed
20
.. parsed-literal::
21

Markus Scheidgen's avatar
Markus Scheidgen committed
22
23
24
    pip install nomad[parsing] --extra-index-url |pypi_url|
    pip install nomad[infrastructure] --extra-index-url |pypi_url|
    pip install nomad[dev] --extra-index-url |pypi_url|
25
26
27
28

The various *extras* have the following meaning:

- ``parsing``, everything necessary to run the parsers
Markus Scheidgen's avatar
Markus Scheidgen committed
29
- ``infrastructure``, everything to run NOMAD services
30
- ``dev``, additional tools that are necessary to develop NOMAD