From b1deaa8cac02e23b0abec4e36017d36f1c1977a4 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 25 May 2023 15:54:10 +0200 Subject: [PATCH 01/14] feat: deploy a github page --- .github/workflows/deploy.yml | 47 ++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 .github/workflows/deploy.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..6b1c7bc --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,47 @@ +name: Build and Deploy + +on: + push: + branches: + - voici + - main + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: '3.10' + - name: Install mamba + uses: mamba-org/provision-with-micromamba@main + with: + micromamba-version: '1.4.2' + environment-file: 'build-environment.yml' + - name: Build the JupyterLite site + shell: bash -l {0} + run: voici build --contents content --output-dir dist + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: ./dist + + deploy: + needs: build + if: github.ref == 'refs/heads/main' + permissions: + pages: write + id-token: write + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 From 26ee6a8caa7beb5b8b2d34cb7c5630ffe2555b6b Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 25 May 2023 15:55:08 +0200 Subject: [PATCH 02/14] feat: add a mamba environment --- environment.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 environment.yml diff --git a/environment.yml b/environment.yml new file mode 100644 index 0000000..9f6ff65 --- /dev/null +++ b/environment.yml @@ -0,0 +1,5 @@ +name: voici +channels: + - https://repo.mamba.pm/conda-forge +dependencies: + - sepal-ui From 6fc42d35722c50ae874b80314e0923bd6e2a8758 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 25 May 2023 15:56:50 +0200 Subject: [PATCH 03/14] fix: add build-environment file --- build-environment.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 build-environment.yml diff --git a/build-environment.yml b/build-environment.yml new file mode 100644 index 0000000..2acb905 --- /dev/null +++ b/build-environment.yml @@ -0,0 +1,10 @@ +name: build-env +channels: + - conda-forge +dependencies: + - python + - pip + - sepal-ui + - pip: + - voici>=0.4.4,<0.5.0 + - jupyterlite-xeus-python>=0.8.1,<0.9.0 From 89f4e0401f0ad33a8557c15aae1b0ea125042e5f Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 25 May 2023 15:57:17 +0200 Subject: [PATCH 04/14] Create build-environment.yml --- build-environment.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 build-environment.yml diff --git a/build-environment.yml b/build-environment.yml new file mode 100644 index 0000000..2acb905 --- /dev/null +++ b/build-environment.yml @@ -0,0 +1,10 @@ +name: build-env +channels: + - conda-forge +dependencies: + - python + - pip + - sepal-ui + - pip: + - voici>=0.4.4,<0.5.0 + - jupyterlite-xeus-python>=0.8.1,<0.9.0 From 3a98734050c19850b5541e7a8eb770a98f895a84 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 25 May 2023 16:03:10 +0200 Subject: [PATCH 05/14] use latest micromamba action --- .github/workflows/deploy.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 6b1c7bc..f09fba4 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -17,10 +17,14 @@ jobs: with: python-version: '3.10' - name: Install mamba - uses: mamba-org/provision-with-micromamba@main + uses: mamba-org/setup-micromamba@v1 with: micromamba-version: '1.4.2' environment-file: 'build-environment.yml' + init-shell: >- + bash + cache-environment: true + post-cleanup: 'all' - name: Build the JupyterLite site shell: bash -l {0} run: voici build --contents content --output-dir dist From a85408e0dad0c46e1d2866541241385b19e465e1 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 25 May 2023 16:06:59 +0200 Subject: [PATCH 06/14] init only bash --- .github/workflows/deploy.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index f09fba4..ade1b5e 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -21,9 +21,7 @@ jobs: with: micromamba-version: '1.4.2' environment-file: 'build-environment.yml' - init-shell: >- - bash - cache-environment: true + init-shell: bash post-cleanup: 'all' - name: Build the JupyterLite site shell: bash -l {0} From 8a7a16dcaf0e939c74d40ea671c5578e5d70be34 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 25 May 2023 16:26:16 +0200 Subject: [PATCH 07/14] Update deploy.yml --- .github/workflows/deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index ade1b5e..16e1773 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -22,7 +22,7 @@ jobs: micromamba-version: '1.4.2' environment-file: 'build-environment.yml' init-shell: bash - post-cleanup: 'all' + log-level: debug - name: Build the JupyterLite site shell: bash -l {0} run: voici build --contents content --output-dir dist From af943bbe87f5f21028e57a88c97e8d8fc84665c2 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 25 May 2023 16:33:00 +0200 Subject: [PATCH 08/14] refactor add ' --- build-environment.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/build-environment.yml b/build-environment.yml index 2acb905..90626f1 100644 --- a/build-environment.yml +++ b/build-environment.yml @@ -2,9 +2,9 @@ name: build-env channels: - conda-forge dependencies: - - python - - pip - - sepal-ui + - 'python' + - 'pip' + - 'sepal-ui' - pip: - voici>=0.4.4,<0.5.0 - jupyterlite-xeus-python>=0.8.1,<0.9.0 From 9ff80403baa1edc7b8ffb411cb5e6e3758da6880 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 25 May 2023 16:36:17 +0200 Subject: [PATCH 09/14] unpin mama version --- .github/workflows/deploy.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 16e1773..2859022 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -19,10 +19,8 @@ jobs: - name: Install mamba uses: mamba-org/setup-micromamba@v1 with: - micromamba-version: '1.4.2' environment-file: 'build-environment.yml' init-shell: bash - log-level: debug - name: Build the JupyterLite site shell: bash -l {0} run: voici build --contents content --output-dir dist From 312b53453b9f2b6b43a9b5d922a82d84be454f0e Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Fri, 26 May 2023 09:27:37 +0200 Subject: [PATCH 10/14] Delete environment.yml --- environment.yml | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 environment.yml diff --git a/environment.yml b/environment.yml deleted file mode 100644 index 9f6ff65..0000000 --- a/environment.yml +++ /dev/null @@ -1,5 +0,0 @@ -name: voici -channels: - - https://repo.mamba.pm/conda-forge -dependencies: - - sepal-ui From 56fe867bced77ca9ede6c0b1cc9d3440d661535c Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Fri, 26 May 2023 09:49:55 +0200 Subject: [PATCH 11/14] Update deploy.yml --- .github/workflows/deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 2859022..00de236 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -23,7 +23,7 @@ jobs: init-shell: bash - name: Build the JupyterLite site shell: bash -l {0} - run: voici build --contents content --output-dir dist + run: voici build --contents . --output-dir dist - name: Upload artifact uses: actions/upload-pages-artifact@v1 with: From aaeab767af4cb73d3dadf18e1c7e5495c5a2a3b6 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Fri, 26 May 2023 09:58:19 +0200 Subject: [PATCH 12/14] deploy on voici branch --- .github/workflows/deploy.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 00de236..81a3931 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -31,7 +31,6 @@ jobs: deploy: needs: build - if: github.ref == 'refs/heads/main' permissions: pages: write id-token: write From f1d83d6e02d302bd271497871580d1028c717302 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Fri, 26 May 2023 10:05:22 +0200 Subject: [PATCH 13/14] only build main --- .github/workflows/deploy.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 81a3931..00de236 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -31,6 +31,7 @@ jobs: deploy: needs: build + if: github.ref == 'refs/heads/main' permissions: pages: write id-token: write From 2a75594af8d8c5dde959e8b2b99d81b357c7542e Mon Sep 17 00:00:00 2001 From: dfguerrerom Date: Fri, 18 Aug 2023 18:54:05 +0200 Subject: [PATCH 14/14] Update doc/en.rst --- doc/en.rst | 70 +++++++++++++++++++++++++++--------------------------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/doc/en.rst b/doc/en.rst index 54b08c8..a5ef735 100644 --- a/doc/en.rst +++ b/doc/en.rst @@ -1,59 +1,58 @@ Planet order ============ -This dasboard application based on the `sepal-ui `_ framework, provide the user with a friendly interface to explore and download Planet Labs images. +This dasboard application, based on the `SEPAL-UI `_ framework, provides users with an interface to explore and download Planet Lab images. .. thumbnail:: https://raw.githubusercontent.com/12rambau/planet-order/master/doc/img/demo.png :group: planet-order -.. warning:: +.. attention:: - in order to start this module, you need to have register on the planet NICFI contract (`Register NICFI PlanetLab `_) and connect your GEE account to SEPAL (`connect GEE to SEPAL `_). + To start this module, you need to (`sign up for NICFI `_) and (`connect your GEE account to SEPAL `_). +On the landing page of our module, in the lower left of the window, you will find three buttons: -In the landing page of our module at the bottom left of the window, you'll find 3 buttons: - -- The :btn:`` will open in a new tab the GitHub repository that is used to create this module. our code is open-source and distributed under the MIT License. -- The :btn:`` button will lead you to the wiki page -- The :btn:`` will open in a new tab the isse tracker of our GitHub repository. You can write here if you experience bugs or if you have any feature request. Our maintainer will answer as fast as possible. +- :btn:``: Opens the GitHub repository that is used to create this module in a new tab (our code is open-source and distributed under the MIT license). +- :btn:``: Leads to the wiki page. +- :btn:``: Opens the issue tracker of our GitHub repository in a new tab (you can write here if you experience bugs or if you have any feature requests; the SEPAL team will answer as quickly as possible). Parameters ---------- -In the lower right corner, 2 tabs are available: +In the lower-right corner, two tabs are available: -- :btn:`` the Area of interest selection PlanetLab -- :btn:`` The planet authentification PlanetLab +- :btn:``: Planet Lab area of interest (AOI) selection +- :btn:``: Planet Lab authentification -In the top left corner, 3 other tbas will allow you ton interact with the data: +In the upper-left corner, three other tabs will allow you to interact with data: -- :btn:`` the Planet order manager -- :btn:`` The color management -- :btn:`` the Download panel +- :btn:``: the Planet order manager +- :btn:``: color management +- :btn:``: download panel Select an AOI ------------- -The application use the same AOI selector that you will find in lots of other application in SEPAL. Go to the `Module AOI section `__ for more information. +The application uses the same AOI selector that you will find in many other SEPAL applications (see the `Module AOI section `__ for more information). Planet Lab authentication ------------------------- -To authenticate the user, feel the form in the second tab with either your credentials or a planet API key. you can find it in your Planet profile page in the settings section. Once the values are set click on :btn:`validate`. If your Planet credentials are valid, the :btn:`NICFI` button should turn green. You can now select a mosaic in the provided list. +To authenticate the user, complete the form in the second tab with either your credentials or a Planet API key, which you can find in the settings section in your Planet profile page. Once the values are set, select :btn:`Validate`. If your Planet credentials are valid, the :btn:`NICFI` button should turn green. You can now select a mosaic from the provided list. .. thumbnail:: https://raw.githubusercontent.com/12rambau/planet-order/master/doc/img/planet_auth.png :group: planet-order .. note:: - If you're not yet register to Planet please follow our `documentation `_ + If you're not yet registered to Planet, please follow `the documentation for signing up for Planet Lab data `_. Manage orders ------------- -In the top-left section, the planet order selector is now activated. You can select any mosaic in the mosaic dropdown on top of the map. using the :btn:`next` or :btn:`prev` button will jump to the next/prev mosaic in the list (they are in chronological order). +In the upper-left section, the **Planet order** selector is now activated. You can select any mosaic in the mosaic dropdown list above the map; use the :btn:`next` or :btn:`prev` button to go to the next or previous mosaic in the list (they are in chronological order). -Once a mosaic is selected the module will display the basemaps on the map. +Once a mosaic is selected, the module will display basemaps on the map. .. thumbnail:: https://raw.githubusercontent.com/12rambau/planet-order/master/doc/img/mosaic_select.png :group: planet-order @@ -61,22 +60,22 @@ Once a mosaic is selected the module will display the basemaps on the map. Manage color combination ------------------------ -Click on :btn:`` on the top-left side of the map. This button will expand and show the different color combo available: +Select :btn:`` on the upper-left side of the map, which will show the different color combinations available, including: -- Red-Green-Blue (RGB) +- Red-green-blue (RGB) - Color-infrared (CIR) -- Normalized Difference Vegetation Index (NDVI) -- Normalized Difference Water Index (NDWI) -- Visual Atmosphere Resistance Index (VARI) -- Modified Soil-adjusted Vegetation Index (MSAVI2) -- Modified Triangular Vegetation Index (MTVI2) -- Triangular Greenness Index (TGI) +- Normalized difference vegetation index (NDVI) +- Normalized difference water index (NDWI) +- Visual atmosphere resistance index (VARI) +- Modified soil-adjusted vegetation index (MSAVI2) +- Modified triangular vegetation index (MTVI2) +- Triangular greenness index (TGI) Selecting one will update the displayed basemap. .. note:: - More information about the band combination can be found on `Planet documentation page `__. + More information about band combination can be found on `the Planet documentation page `__. .. thumbnail:: https://raw.githubusercontent.com/12rambau/planet-order/master/doc/img/mosaic_select_rgb.png :group: planet-order @@ -110,23 +109,24 @@ Selecting one will update the displayed basemap. :group: planet-order :width: 32% -Download Data +Download data ------------- -Once you are satisfied with your mosaic selection, you can click on the :btn:`` button. This will launch the downloading process of your images from Planet server to your folders. +Once you are satisfied with your mosaic selection, you can select the :btn:`` button, which will launch the download process of your images from the Planet server to your folders. -The images will be stored in the following folder : :code:`~/module_results/planet-order///`. +The images will be stored in the following folder: :code:`~/module_results/planet-order///`. .. thumbnail:: https://raw.githubusercontent.com/12rambau/planet-order/master/doc/img/download.png :group: planet-order .. tip:: - In the parent folder (:code:`/home//module_results/planet-order//`) you will find a .geojson file of the planet grid. This can be useful for other tools. + In the parent folder (:code:`/home//module_results/planet-order//`), you will find a .geojson file of the Planet grid, which can be useful for other tools. .. note:: - If the requested image is not available (the grid point to water area, the image was to cloudy so filtered by Planet, you don't have the rights to download it.. etc) the image will fail. - If the image already exist in your folder it will be skipped. This behaviour allow you to restart a process if your SEPAL conection crashed without restarting all the downloads. + If the requested image is not available (e.g. the grid points to water area, the image was too cloudy and filtered by Planet, you don't have the rights to download it, etc.) the image will fail. + If the image already exists in your folder, it will be skipped. This behaviour allows you to restart a process if your SEPAL connection crashes without needing to restart all downloads. +.. custom-edit:: https://raw.githubusercontent.com/sepal-contrib/planet-order/release/doc/en.rst