Commit a413b26b authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Updated pip URLs.

parent 298a5b26
Pipeline #74940 passed with stages
in 19 minutes and 19 seconds
......@@ -4,9 +4,9 @@ Install the NOMAD client library
We release the NOMAD client library as a Python `distutils <>`_ source distribution.
You can install it the usual way using *pip* (or *conda*).
.. code-block:: sh
.. parsed-literal::
pip install https::/
pip install nomad --extra-index-url |pypi_url|
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
......@@ -17,14 +17,14 @@ 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
.. code-block:: sh
.. parsed-literal::
pip install https::/[parsers]
pip install https::/[infra]
pip install https::/[dev]
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|
The various *extras* have the following meaning:
- ``parsing``, everything necessary to run the parsers
- ``infra``, everything to run NOMAD services
- ``infrastructure``, everything to run NOMAD services
- ``dev``, additional tools that are necessary to develop NOMAD
......@@ -28,6 +28,10 @@ project = 'nomad-FAIRDI'
copyright = '2018, FAIRDI e.V.'
author = 'FAIRDI e.V.'
rst_epilog = '''
.. |pypi_url| replace::
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
......@@ -27,9 +27,9 @@ metainfo Python API.
To install the NOMAD Python package, you can use ``pip install`` to install our
source distribution
.. code:: sh
.. parsed-literal::
pip install
pip install nomad --extra-index-url |pypi_url|
First example
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