From 1c620b10f2a932516ed16f6db33905a89bc7b4b9 Mon Sep 17 00:00:00 2001 From: Alex Gregor <111502950+alexryangregor@users.noreply.github.com> Date: Thu, 16 Nov 2023 15:05:29 +0100 Subject: [PATCH] Update gee.rst Proofreading complete. --- docs/source/cli/gee.rst | 38 ++++++++++++++++++++++---------------- 1 file changed, 22 insertions(+), 16 deletions(-) diff --git a/docs/source/cli/gee.rst b/docs/source/cli/gee.rst index ccb8231c6c..626df52b61 100644 --- a/docs/source/cli/gee.rst +++ b/docs/source/cli/gee.rst @@ -1,19 +1,21 @@ -Google Earth Engine -=================== +GEE +=== -The **earthengine** tool is a utility program that allows you to manage Google Earth Engine (GEE) assets and tasks from the command line. It is installed automatically when you install the Python API. To check whether the tool is installed and functioning correctly, enter the following in a command line: +The **Google Earth Engine (GEE)** tool is a utility program that allows you to manage Google Earth Engine (GEE) assets and tasks from the command line. + +The tool is installed automatically when you install the Python API. To check whether it is installed and functioning correctly, enter the following in a command line: .. code-block:: console $ earthengine -If the tool is properly installed, it will print out a short summary of available commands. To get help on a specific command, use: +If the tool is properly installed, it will display a short summary of available commands. To get help on a specific command, use: .. code-block:: console $ earthengine command -h -When you first install the Python API, you will need to login using the :code:`Authenticate` command described below. +When you first install the Python API, you will need to log in using the :code:`Authenticate` command, as described below. Available commands ------------------ @@ -40,19 +42,23 @@ More information on the available command can be found on the `Google API websit $ upload_manifest # Uploads an image to GEE using the given manifest file. $ upload_table_manifest # Uploads a table to GEE using the given manifest file. -Use Google Earth Engine in the Jupyter interface ------------------------------------------------- +Use GEE in the Jupyter interface +-------------------------------- + +We highly suggest working directly from the Python interface of GEE, as Python has been extended by the community (gee_tools, geemap, ipygee, sepal_ui, etc.) and is more user-friendly. + +It's also the best way to prototype a script before using it in a SEPAL application, as the translation from Python to Javascript is not always straightforward. -We highly suggest to work directly from the Python interface of Google Earth Engine as the Pythonhas been extended by the community (gee_tools, geemap, ipygee, sepal_ui etc.) and is more user-friendly. -It's also the best way to prototype a script before using it in a SEPAL application as the translation from Python to Javascript is not always straightforward. +The main advantages of the **GEE code editor** are: -The main advantages of the GEE code editor are: - the access to a live map - the value inspector -SEPAL and Jupyter lab can help you bring this to the next level by providing both tools in a Python notebook, allowing you to also access all the Python geospatil tools created by the Eart obseervation community. +SEPAL and JupyterLab can help you bring this to the next level by providing both tools in a Python notebook, allowing you to also access all Python geospatial tools created by the Earth observation community. -First open a JupyterLab instance and start a notebook. In the first cell create a map and place it the sidecar by running the following code: +First, open a JupyterLab instance and start a notebook. + +In the first cell, create a map and place it the sidecar by running the following code: .. code-block:: python @@ -67,15 +73,15 @@ First open a JupyterLab instance and start a notebook. In the first cell create .. thumbnail:: ../_images/cli/gee/create_a_sidecar.png :title: Some code that will be run in the sidecar -As displayed in the previous image, the list of available sidecars is displayed on the right side of the frame. You can create as many sidecars as you want and display any widget in it. We chose to use the sepal_ui mappping widget as it's including key features such as: +As displayed in the previous image, the list of available sidecars is displayed on the right side of the frame. You can create as many sidecars as you want and display any widget in it. We chose to use the **sepal_ui mappping** widget as it includes key features, such as: + - GEE full compatibility - an extended layer manager - a value inspector -From now the map will be displayed in a sidecar next to thenotebook. The map is running live so in any cell you can add extra layers to it. It's more powerful than the Code editor map as you don't need to run all your cells again to get the map updated. +The map will be displayed in a sidecar next to the notebook. It is running live, so you can add extra layers to it in any cell. Also, it is more powerful than the **Code editor map** as you don't need to run all your cells again to update the map. .. thumbnail:: ../_images/cli/gee/sidecar_with_data.png :title: The map displayed in the sidecar -Now you are all set to create your own GEE script. You can use the GEE Python API documentation to get started. - +Now you are all set to create your own **GEE script** – you can use the **GEE Python API documentation** to get started.