Skip to content

Commit

Permalink
docs: updated install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrunato committed Apr 24, 2024
1 parent 8fbac12 commit 42c60d1
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,9 @@ And with ``conda`` from the `conda-forge channel <https://anaconda.org/conda-for
conda install -c conda-forge eodag
Please note that EODAG comes with a minimal set of dependencies. If you want more features, please install using one of
the `available extras <https://eodag.readthedocs.io/en/latest/getting_started_guide/install.html#optional-dependencies>`_.

Usage
=====

Expand Down
16 changes: 15 additions & 1 deletion docs/getting_started_guide/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,20 @@ Or with ``conda`` from the *conda-forge* channel:
conda install -c conda-forge eodag
Optional dependencies
^^^^^^^^^^^^^^^^^^^^^

Since ``v3.0``, EODAG comes with a minimal set of dependencies. If you want more features, please install using one of
the following extras:

* ``eodag[all]``, includes everything that would be needed to run EODAG and associated tutorials with all features
* ``eodag[all-providers]``, includes dependencies required to have all providers available
* ``eodag[aws]``, includes dependencies for plugins using Amazon S3
* ``eodag[csw]``, includes dependencies for plugins using CSW
* ``eodag[ecmwf]``, includes dependencies for :class:`~eodag.plugins.apis.ecmwf.EcmwfApi` (`ecmwf` provider)
* ``eodag[usgs]``, includes dependencies for :class:`~eodag.plugins.apis.usgs.UsgsApi` (`usgs` provider)
* ``eodag[server]``, includes dependencies for server-mode

.. _install_notebooks:

Run the notebooks locally
Expand All @@ -30,7 +44,7 @@ that can be run locally:

1. Install the extras dependencies it requires by executing this command (preferably in a virtual environment)::

python -m pip install eodag[tutorials]
python -m pip install "eodag[tutorials]"

2. Clone ``eodag`` 's repository with git::

Expand Down

0 comments on commit 42c60d1

Please sign in to comment.