Skip to content

Commit

Permalink
Add documentation for optional dependencies.
Browse files Browse the repository at this point in the history
  • Loading branch information
kripnerl committed Jan 14, 2025
1 parent a060bab commit b0b0832
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion sphinx/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Installation

OMAS runs with *Python3.6+*

**Pypi**: To install `OMAS with pip <https://pypi.python.org/pypi/omas/>`_ (for users):
**PyPI**: To install `OMAS with pip <https://pypi.python.org/pypi/omas/>`_ (for users):

.. code-block:: none
Expand Down Expand Up @@ -38,6 +38,50 @@ The development version of omas can also be installed with pip:
List of `Python package requirements <_static/requirements.txt>`_.

Optional dependencies
---------------------

Some dependencies are not required for the core functionality of OMAS,
but are needed for some of the additional features.

Here is a list of optional dependencies:

.. Table of optional dependencies: mongo, s3, build_structures, build_documentation
+----------------------+----------------------+
| **Package** | **Description** |
+======================+======================+
| `mongo` | Support for MongoDB |
+----------------------+----------------------+
| `s3` | Support for AWS S3 |
+----------------------+----------------------+
| `build_structures` | Support for building IMAS structures |
+----------------------+----------------------+
| `build_documentation`| Support for building Sphinx documentation |
+----------------------+----------------------+

Optional dependencies can be installed with the following command:

**PyPI**:

.. code-block:: none
pip install --upgrade omas[optional,optional2,...]
**Conda**: All optional dependencies are installed by default. To suppress the installation of optional dependencies, use the following command:

.. code-block:: none
conda install -c conda-forge omas --no-deps
**GitHub**:

.. code-block:: none
pip install --upgrade -e '.[optional,optional2,...]'
**Note**: Skip the `--upgrade` option if you are installing the package for the first time.

Installation with IMAS
======================

Expand Down

0 comments on commit b0b0832

Please sign in to comment.