Package: eodag-labextension
eodag-labextensionSearching and browsing remote sensed imagery directly from JupyterLab.This extension is using theeodaglibrary to efficiently search from various image
providers. It can transform search results to code cells into the active Python notebook to further process/visualize
the dataset.The extension is composed of a Python package namedeodag-labextension, and add a tab into the left panel of Jupyter
Lab. The package consist of a Python Jupyter notebook REST service consumed by the client and served at/eodag/or/user/<username>/eodag/for JupyterHub (a home page is available at that URL).RequirementsCompatibilityInstallConfigurationQuickStartSearchResults overviewApply to the Jupyter notebookUser manualContributeTroubleshootingLicenseRequirementspip >= 21.0Compatibilitynewesteodag-labextensionversions are compatibles with JupyterLab v3v3.1.3 is the latest version compatible with JupyterLab v2v2.1.3 is the latest version compatible with JupyterLab v1Installpipinstalleodag-labextensionYou can also uninstall it quite simply.pipuninstalleodag-labextensionConfigurationeodag configuration file should be localized at~/.config/eodag/eodag.yaml(seeeodag documentation).
Make sure that that file is configured properly.QuickStartYou can useeodag-labextensioninside a Jupyter notebook. Start Jupyter lab withjupyter lab, and in Jupyter lab
open a notebook.SearchClick on this icon in the left of JupyterLab interface to open EODAG-Labextension tab.With displayed search form, you can enter search extent and following search criteria:Provider: the provider on which to perform the search. If no provider is selected, search will loop on providers
bypriority, and
return the first non empty results.Product type: the searched product type. List filtering is performed using product types description keywords.
For each entry of the drop-down list, a tooltip is displayed at hovering time with corresponding title.Date range: minimal and maximal dates of the search temporal window.Max cloud cover: maximum cloud cover allowed in search results in percent. 100% will disable cloud cover
filtering.Additional parameters: used to enter key-value pairs criteria for the request. Seeavailable parameters in EODAG documentation.Assearch geometryyou can draw multiple extents, or use none. Each extent can be a rectangle or a free polygon.Product type is mandatory. Other criteria are optional.Once search criteria are filled out, click on:Generate Codeto automatically generate and insert the corresponding eodag search code bellow the active cell.Preview Resultsto perform a search in background, display results, and generate search code in a second step.Click on this icon to open EODAG-Labextension settings. You will be enable to choose whether newly inserted code should
replace existing search code or not.Results overviewThe results overview popup is compopsed of 3 parts:a map showing products extent,a table listing products,a pane containing metadata for currently selected product.The results table allows you to access product metadata by clicking on the desired product line. The magnifying glass
button allows you to zoom in on the product's in the map view. By scrolling down in the list of results, the search is
automatically restarted to retrieve the following results.In the metadata view, clicking on theQuicklookdisplays it in native resolution. Clicking it again reduces its size
again.Apply to the Jupyter notebookIf the search result is correct, clicking on the "Generate code" button will insert the Python eodag code in a new cell
after the selected cell of the currently open notebook. The popup is automatically closed. From there, it is possible
to work in the notebook on the search results by executing the eodag search.Here is an example of generated code:fromeodagimportEODataAccessGateway,setup_loggingsetup_logging(1)# 0: nothing, 1: only progress bars, 2: INFO, 3: DEBUGdag=EODataAccessGateway()geometry="POLYGON ((0.550136 43.005451, 0.550136 44.151469, 2.572104 44.151469, 2.572104 43.005451, 0.550136 43.005451))"search_results,total_count=dag.search(productType="S2_MSI_L1C",geom=geometry,start="2021-08-01",end="2021-08-11",cloudCover=17,)User manualPlease refer to theuser manual notebookfor results usage examples.ContributeHave you observed a bug while runningeodag-labextension?
Do you have a suggestion for a new feature?Don't hesitate and open an issue or submit a pull request, contributions are most welcome!For guidance on setting up a development environment and how to make a
contribution toeodag-labextension, see thecontributing guidelines.TroubleshootingIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistTo submit an issue, please go togithub issues.LicenseThis software is licensed under Apache License v2.0.
See LICENSE file for details.Copyright 2022 CS GROUP - France
All rights reserved