Skip to content

Commit

Permalink
docs: README update
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrunato committed Jan 18, 2023
1 parent a4876c0 commit 611c5a7
Showing 1 changed file with 33 additions and 19 deletions.
52 changes: 33 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

Searching and browsing remote sensed imagery directly from JupyterLab.

![screencast](https://raw.githubusercontent.com/CS-SI/eodag-labextension/develop/notebooks/images/eodag_labext_screencast.gif)
![screencast](notebooks/images/eodag_labext_screencast.gif)

This extension is using the [eodag](https://github.com/CS-SI/eodag) library to efficiently search from various image
providers. It can transform search results to code cells into the active Python notebook to further process/visualize
Expand Down Expand Up @@ -63,41 +63,55 @@ Make sure that that file is configured properly.
You can use `eodag-labextension` inside a Jupyter notebook. Start Jupyter lab with `jupyter lab`, and in Jupyter lab
open a notebook.

![extension logo](https://raw.githubusercontent.com/CS-SI/eodag-labextension/develop/notebooks/images/eodag_labext_form.png)
## Search

### Search
![extension logo](notebooks/images/eodag_labext_icon.png) Click on this icon in the left of JupyterLab interface to open
EODAG-Labextension tab.

![extension logo](https://raw.githubusercontent.com/CS-SI/eodag-labextension/develop/notebooks/images/eodag_labext_icon.png)
Open the EODAG tab on the left side of the JupuytuerLab interface by clicking on that icon.
<img style="float: left; margin-right: 30px; border: solid; border-color: Gainsboro; "
src="notebooks/images/eodag_labext_form.png" alt="form">

With displayed search form, you can enter select your data geographically and apply some search criteria:
With displayed search form, you can enter search extent and following search criteria:

- **Product type**: the searched product type. For each entry of the drop-down list, a tooltip is displayed at
hovering time with corresponding description.
- **Start date**: minimal date of the search temporal window.
- **End date**: maximal date of the search temporal window.
- **Max cloud cover**: maximum cloud cover allowed in search results in percent.
- **Additional parameters**: used to enter key-value pairs criteria for the request.
- **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 description.
<!-- markdownlint-disable-next-line no-inline-html -->
<img style="display: block;" src="notebooks/images/eodag_labext_product_types.png" alt="product types">

You 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.
- **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. See
[available parameters in EODAG documentation](https://eodag.readthedocs.io/en/stable/add_provider.html#opensearch-parameters-csv).

Once search criteria are filled out, click on the "Search" button to proceed to next step. At the end of the search,
a popup opens and displays results.
As **search geometry** you 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._

<span style="clear: left; display:block;"></span> <!-- markdownlint-disable no-inline-html -->
Once search criteria are filled out, click on:

- `Generate Code` to automatically generate and insert the corresponding eodag search code bellow the active cell.
- `Preview Results` to perform a search in background, display results, and generate search code in a second step.

![settings logo](notebooks/images/eodag_labext_settings_icon.png) 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 overview

![extension popup](notebooks/images/eodag_labext_popup.png)

The results overview popup is compopsed of 3 parts:

- a map showing products extent
- a table listing products
- 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 the thumbnail displays it in native resolution. Clicking it again reduces its size
In the metadata view, clicking on the _Quicklook_ displays it in native resolution. Clicking it again reduces its size
again.

### Apply to the Jupyter notebook
Expand Down

0 comments on commit 611c5a7

Please sign in to comment.