Installation

Installation#

EODAG is really simple to install with pip:

python -m pip install eodag

Note

pyproj requires Cython or pip>=19.3. If the install of eodag fails, check your version of pip (Ubuntu 18.04 comes installed with pip 9.0.1).

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,csw,tutorials])

  • eodag[all-providers], includes dependencies required to have all providers available (== eodag[ecmwf,usgs])

  • eodag[csw], includes dependencies for plugins using CSW

  • eodag[ecmwf], includes dependencies for EcmwfApi (ecmwf provider)

  • eodag[usgs], includes dependencies for UsgsApi (usgs provider)

Also available:

  • eodag[notebook], includes notebook adapted progress bars

  • eodag[tutorials], includes dependencies to run notebooks (eodag[ecmwf,notebook], visualisation and jupyter-related stuff)

  • eodag[stubs], includes dependencies stubs

  • eodag[dev], includes dependencies required for contributing (eodag[all-providers,csw,stubs], testing and linting tools)

  • eodag[docs], includes dependencies required to build documentation

Conda#

Conda does not support for the moment optional groups of dependencies (conda/conda#7502).

Package is available on conda-forge/eodag (equivalent to eodag[all-providers,csw]).

Run the notebooks locally#

The API User Guide and the Tutorials consist of a series of Jupyter notebooks 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]"

  2. Clone eodag ‘s repository with git:

    git clone https://github.com/CS-SI/eodag.git

  3. Invoke jupyter:

    jupyter notebook

  4. Browse to either docs/notebooks/api_user_guide or docs/notebooks/tutos and launch a notebook.

Contents