# eodag-labextension
[](https://badge.fury.io/py/eodag-labextension)
[](https://jupyter.org/)
[](https://github.com/psf/black)
[](https://mybinder.org/v2/git/https%3A%2F%2Fgithub.com%2FCS-SI%2Feodag-labextension.git/master?urlpath=lab%2Ftree%2Fnotebooks%2Fbasic_usage.ipynb)
Searching and browsing remote sensed imagery directly from JupyterLab.
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
the dataset.
The extension is composed of a Python package named `eodag-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).
- [Requirements](#requirements)
- [Compatibility](#compatibility)
- [Install](#install)
- [Configuration](#configuration)
- [QuickStart](#quickstart)
- [Search](#search)
- [Settings](#settings)
- [Results overview](#results-overview)
- [Apply to the Jupyter notebook](#apply-to-the-jupyter-notebook)
- [User manual](#user-manual)
- [Contribute](#contribute)
- [Troubleshooting](#troubleshooting)
- [License](#license)
## Requirements
- pip >= 21.0
## Compatibility
- newest `eodag-labextension` versions are compatibles with JupyterLab v3
- v3.1.3 is the latest version compatible with JupyterLab v2
- v2.1.3 is the latest version compatible with JupyterLab v1
## Install
```bash
pip install eodag-labextension
```
You can also uninstall it quite simply.
```bash
pip uninstall eodag-labextension
```
### Configuration
eodag configuration file should be localized at `~/.config/eodag/eodag.yaml` (see
[eodag documentation](https://eodag.readthedocs.io/en/latest/getting_started_guide/configure.html)).
Make sure that that file is configured properly.
## QuickStart
You can use `eodag-labextension` inside a Jupyter notebook. Start Jupyter lab with `jupyter lab`, and in Jupyter lab
open a notebook.
## Search
Click 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
by [priority](https://eodag.readthedocs.io/en/stable/getting_started_guide/configure.html#priority-setting), 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. See
[available parameters in EODAG documentation](https://eodag.readthedocs.io/en/stable/add_provider.html#opensearch-parameters-csv).
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._
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
Click on this icon to reload [EODAG configuration](https://eodag.readthedocs.io/en/stable/getting_started_guide/configure.html)
and take into account your updated credentials or providers settings.
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;
- configure the default map settings.
### Results overview
The 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 the _Quicklook_ displays it in native resolution. Clicking it again reduces its size
again.
### Apply to the Jupyter notebook
If 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:
```python
from eodag import EODataAccessGateway, setup_logging
setup_logging(1) # 0: nothing, 1: only progress bars, 2: INFO, 3: DEBUG
dag = 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 manual
Please refer to the
[user manual notebook](https://github.com/CS-SI/eodag-labextension/blob/develop/notebooks/user_manual.ipynb)
for results usage examples.
## Contribute
Have you observed a bug while running `eodag-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 to `eodag-labextension`, see the
[contributing guidelines](https://github.com/CS-SI/eodag-labextension/blob/develop/CONTRIBUTING.md).
## Troubleshooting
If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:
```bash
jupyter server extension list
```
If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:
```bash
jupyter labextension list
```
To submit an issue, please go to [github issues](https://github.com/CS-SI/eodag-labextension/issues).
## License
This software is licensed under Apache License v2.0.
See LICENSE file for details.
_Copyright 2022 CS GROUP - France
All rights reserved_
Raw data
{
"_id": null,
"home_page": "https://github.com/CS-SI/eodag-labextension",
"name": "eodag-labextension",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3",
"author": "CS Group",
"author_email": "admin@geostorm.eu",
"download_url": "https://files.pythonhosted.org/packages/a2/a2/ab006f5b439ff33ac5e0131649fadd83e549d7eac6702e73e2017980cf00/eodag_labextension-3.6.0.tar.gz",
"platform": "Linux",
"description": "# eodag-labextension\n\n[](https://badge.fury.io/py/eodag-labextension)\n[](https://jupyter.org/)\n[](https://github.com/psf/black)\n[](https://mybinder.org/v2/git/https%3A%2F%2Fgithub.com%2FCS-SI%2Feodag-labextension.git/master?urlpath=lab%2Ftree%2Fnotebooks%2Fbasic_usage.ipynb)\n\nSearching and browsing remote sensed imagery directly from JupyterLab.\n\n\n\nThis extension is using the [eodag](https://github.com/CS-SI/eodag) library to efficiently search from various image\nproviders. It can transform search results to code cells into the active Python notebook to further process/visualize\nthe dataset.\n\nThe extension is composed of a Python package named `eodag-labextension`, and add a tab into the left panel of Jupyter\nLab. The package consist of a Python Jupyter notebook REST service consumed by the client and served at `/eodag/` or\n`/user/<username>/eodag/` for JupyterHub (a home page is available at that URL).\n\n- [Requirements](#requirements)\n- [Compatibility](#compatibility)\n- [Install](#install)\n - [Configuration](#configuration)\n- [QuickStart](#quickstart)\n - [Search](#search)\n - [Settings](#settings)\n - [Results overview](#results-overview)\n - [Apply to the Jupyter notebook](#apply-to-the-jupyter-notebook)\n - [User manual](#user-manual)\n- [Contribute](#contribute)\n- [Troubleshooting](#troubleshooting)\n- [License](#license)\n\n## Requirements\n\n- pip >= 21.0\n\n## Compatibility\n\n- newest `eodag-labextension` versions are compatibles with JupyterLab v3\n- v3.1.3 is the latest version compatible with JupyterLab v2\n- v2.1.3 is the latest version compatible with JupyterLab v1\n\n## Install\n\n```bash\npip install eodag-labextension\n```\n\nYou can also uninstall it quite simply.\n\n```bash\npip uninstall eodag-labextension\n```\n\n### Configuration\n\neodag configuration file should be localized at `~/.config/eodag/eodag.yaml` (see\n[eodag documentation](https://eodag.readthedocs.io/en/latest/getting_started_guide/configure.html)).\nMake sure that that file is configured properly.\n\n## QuickStart\n\nYou can use `eodag-labextension` inside a Jupyter notebook. Start Jupyter lab with `jupyter lab`, and in Jupyter lab\nopen a notebook.\n\n## Search\n\n\nClick on this icon in the left of JupyterLab interface to open EODAG-Labextension tab.\n\n\n\nWith displayed search form, you can enter search extent and following search criteria:\n\n- **Provider**: the provider on which to perform the search. If no provider is selected, search will loop on providers\n by [priority](https://eodag.readthedocs.io/en/stable/getting_started_guide/configure.html#priority-setting), and\n return the first non empty results.\n- **Product type**: the searched product type. List filtering is performed using product types description keywords.\n For each entry of the drop-down list, a tooltip is displayed at hovering time with corresponding title.\n \n\n- **Date range**: minimal and maximal dates of the search temporal window.\n- **Max cloud cover**: maximum cloud cover allowed in search results in percent. 100% will disable cloud cover\n filtering.\n- **Additional parameters**: used to enter key-value pairs criteria for the request. See\n [available parameters in EODAG documentation](https://eodag.readthedocs.io/en/stable/add_provider.html#opensearch-parameters-csv).\n\nAs **search geometry** you can draw multiple extents, or use none. Each extent can be a rectangle or a free polygon.\n\n_Product type is mandatory. Other criteria are optional._\n\nOnce search criteria are filled out, click on:\n\n- `Generate Code` to automatically generate and insert the corresponding eodag search code bellow the active cell.\n- `Preview Results` to perform a search in background, display results, and generate search code in a second step.\n\n## Settings\n\n\nClick on this icon to reload [EODAG configuration](https://eodag.readthedocs.io/en/stable/getting_started_guide/configure.html)\nand take into account your updated credentials or providers settings.\n\n\nClick on this icon to open EODAG-Labextension settings. You will be enable to:\n\n- choose whether newly inserted code should replace existing search code or not;\n- configure the default map settings.\n\n\n\n### Results overview\n\n\n\nThe results overview popup is compopsed of 3 parts:\n\n- a map showing products extent,\n- a table listing products,\n- a pane containing metadata for currently selected product.\n\nThe results table allows you to access product metadata by clicking on the desired product line. The magnifying glass\nbutton allows you to zoom in on the product's in the map view. By scrolling down in the list of results, the search is\nautomatically restarted to retrieve the following results.\n\nIn the metadata view, clicking on the _Quicklook_ displays it in native resolution. Clicking it again reduces its size\nagain.\n\n### Apply to the Jupyter notebook\n\nIf the search result is correct, clicking on the \"`Generate code`\" button will insert the Python eodag code in a new cell\nafter the selected cell of the currently open notebook. The popup is automatically closed. From there, it is possible\nto work in the notebook on the search results by executing the eodag search.\n\nHere is an example of generated code:\n\n```python\nfrom eodag import EODataAccessGateway, setup_logging\n\nsetup_logging(1) # 0: nothing, 1: only progress bars, 2: INFO, 3: DEBUG\n\ndag = EODataAccessGateway()\ngeometry = \"POLYGON ((0.550136 43.005451, 0.550136 44.151469, 2.572104 44.151469, 2.572104 43.005451, 0.550136 43.005451))\"\nsearch_results, total_count = dag.search(\n productType=\"S2_MSI_L1C\",\n geom=geometry,\n start=\"2021-08-01\",\n end=\"2021-08-11\",\n cloudCover=17,\n)\n```\n\n### User manual\n\nPlease refer to the\n[user manual notebook](https://github.com/CS-SI/eodag-labextension/blob/develop/notebooks/user_manual.ipynb)\nfor results usage examples.\n\n## Contribute\n\nHave you observed a bug while running `eodag-labextension`?\nDo you have a suggestion for a new feature?\n\nDon't hesitate and open an issue or submit a pull request, contributions are most welcome!\n\nFor guidance on setting up a development environment and how to make a\ncontribution to `eodag-labextension`, see the\n[contributing guidelines](https://github.com/CS-SI/eodag-labextension/blob/develop/CONTRIBUTING.md).\n\n## Troubleshooting\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\n```\n\nTo submit an issue, please go to [github issues](https://github.com/CS-SI/eodag-labextension/issues).\n\n## License\n\nThis software is licensed under Apache License v2.0.\nSee LICENSE file for details.\n\n_Copyright 2022 CS GROUP - France\nAll rights reserved_\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Searching remote sensed imagery from various image providers",
"version": "3.6.0",
"project_urls": {
"Homepage": "https://github.com/CS-SI/eodag-labextension"
},
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "111ea171b881c29a6b08a9ad9fc9cac8adfeeea3eb07111add4ab9b7b730e87b",
"md5": "a2ce310c11c7a1add655f2c2de57992c",
"sha256": "65fc16e9d75310016f9384e2dfaf054c8561177b25508fea6681fab593490722"
},
"downloads": -1,
"filename": "eodag_labextension-3.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2ce310c11c7a1add655f2c2de57992c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1365340,
"upload_time": "2024-03-04T15:49:47",
"upload_time_iso_8601": "2024-03-04T15:49:47.749944Z",
"url": "https://files.pythonhosted.org/packages/11/1e/a171b881c29a6b08a9ad9fc9cac8adfeeea3eb07111add4ab9b7b730e87b/eodag_labextension-3.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a2a2ab006f5b439ff33ac5e0131649fadd83e549d7eac6702e73e2017980cf00",
"md5": "4f4b15dc34b5fc719f0cb8592a119fd3",
"sha256": "86007c3f4bc062606a62746fa4bec40ebe301f5837c1923163b19ad7a0e14dad"
},
"downloads": -1,
"filename": "eodag_labextension-3.6.0.tar.gz",
"has_sig": false,
"md5_digest": "4f4b15dc34b5fc719f0cb8592a119fd3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 834202,
"upload_time": "2024-03-04T15:49:49",
"upload_time_iso_8601": "2024-03-04T15:49:49.867753Z",
"url": "https://files.pythonhosted.org/packages/a2/a2/ab006f5b439ff33ac5e0131649fadd83e549d7eac6702e73e2017980cf00/eodag_labextension-3.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 15:49:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CS-SI",
"github_project": "eodag-labextension",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "eodag-labextension"
}
JSON
