Merge pull request #359 from MAAP-Project/develop

Merge into master
MAAP-Project · Nov 3, 2023 · 7118d47 · 7118d47
2 parents beb5fd2 + 348f43d
commit 7118d47
Show file tree

Hide file tree

Showing 14 changed files with 1,709 additions and 70 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ build/
 .ipynb_checkpoints
 mosaic.json
 *.h5
+*venv/
diff --git a/docs/source/_static/algo_reg/algo_reg_access.png b/docs/source/_static/algo_reg/algo_reg_access.png
diff --git a/docs/source/_static/faq_images/algorithm_dropdown.png b/docs/source/_static/faq_images/algorithm_dropdown.png
diff --git a/docs/source/_static/faq_images/delete_algorithm.png b/docs/source/_static/faq_images/delete_algorithm.png
diff --git a/docs/source/_static/faq_images/select_an_algorithm_to_delete.png b/docs/source/_static/faq_images/select_an_algorithm_to_delete.png
diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst
@@ -1,6 +1,65 @@
 Release Notes
 =======================================
 
+-------------------------------------------------------------
+3.1.3
+-------------------------------------------------------------
+| November 2, 2023
+| Minor feature additions and bug fixes.
+
+
+Added
+^^^^^^^^^^^^
+* Capability to stop running jobs from the MAAP API (maap-py ``maap.cancelJob("id")``): https://github.com/MAAP-Project/Community/issues/640
+* New maap-py method ``aws.workspace_bucket_credentials()`` for accessing user workspace bucket from outside the ADE: https://github.com/MAAP-Project/Community/issues/825
+* Jobs UI: expose the entire stderr; split "View" and "Submit" into two tabs: https://github.com/MAAP-Project/Community/issues/651
+* maap-py: add ``maap.downloadGranule()`` direct download of Earthdata Cloud URLs: https://github.com/MAAP-Project/Community/issues/515
+* Add 'listContainer' support to MAAP API and maap-py: https://github.com/MAAP-Project/Community/issues/818
+
+Fixed
+^^^^^^^^^^^^
+* Removed 5-second delay when submitting jobs to DPS: https://github.com/MAAP-Project/Community/issues/762
+* ADE menu cleanup: updated menu items for jobs/algorithms and persistence of extensions on page refresh: https://github.com/MAAP-Project/Community/issues/833
+
+Changed
+^^^^^^^^^^^^
+* Sort/filtering enhancements in the ADE Jobs UI: https://github.com/MAAP-Project/Community/issues/649
+* Copy submit job code with formatting when using Submit Job UI: https://github.com/MAAP-Project/Community/issues/791
+* Alphabetize the list of algorithms available in the job submission ui: https://github.com/MAAP-Project/Community/issues/829
+
+Removed
+^^^^^^^^^^^^
+* Archived shared documents from the MAAP portal along with Memphis WordPress Plugin: https://github.com/MAAP-Project/Community/issues/821
+
+
+-------------------------------------------------------------
+3.1.1
+-------------------------------------------------------------
+| October 4, 2023
+| Minor feature additions and bug fixes.
+
+
+Added
+^^^^^^^^^^^^
+* DPS authentication support--jobs can now access secure API endpoints such as aws.earthdata_s3_credentials: https://github.com/MAAP-Project/Community/issues/717
+* Added memory extension in the footer bar of Jupyter workspaces indicating memory usage within a notebook: https://github.com/MAAP-Project/Community/issues/749
+
+Fixed
+^^^^^^^^^^^^
+* Presigned url bug fix for missing output when generated s3 urls: https://github.com/MAAP-Project/Community/issues/758
+* Fixed maap-py.deleteAlgorithm() 404 error: https://github.com/MAAP-Project/Community/issues/814
+
+Changed
+^^^^^^^^^^^^
+* Updated stac_ipyleaflet to 0.3.5 for Pangeo.
+* Updated MAAP help tour: https://github.com/MAAP-Project/Community/issues/618
+* Migrated DPS instances to OL8: https://github.com/MAAP-Project/Community/issues/739
+
+Removed
+^^^^^^^^^^^^
+* isce2 workspaces are now deprecated.
+
+
 -------------------------------------------------------------
 3.1.0
 -------------------------------------------------------------

diff --git a/docs/source/system_reference_guide/algorithm_registration.ipynb b/docs/source/system_reference_guide/algorithm_registration.ipynb
@@ -28,7 +28,7 @@
    "source": [
     "## Register an Algorithm\n",
     "1. Open the __Register Algorithm__ UI.\n",
-    "2. Fill out the fields describing general information about the algorithm. This includes things like the repository the algorithm is stored in, the repository branch (also refered to as the version of the algorithm), the command to execute the algorithm, etc.\n",
+    "2. Fill out the fields describing general information about the algorithm. This includes things like the repository the algorithm is stored in, the repository branch or tag (also referred to as the version of the algorithm), the command to execute the algorithm, etc.\n",
     "\n",
     "![](../_static/algo_reg/algo_reg_reg_general.png)\n",
     "\n",
@@ -40,6 +40,14 @@
     "\n",
     "![](../_static/algo_reg/algo_reg_reg_ci.png)"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1f838e93-a191-4a72-84cf-e22c31c7ec9d",
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
@@ -58,7 +66,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.4"
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

diff --git a/docs/source/system_reference_guide/faq.rst b/docs/source/system_reference_guide/faq.rst
@@ -8,4 +8,5 @@ FAQ
   faq/copy_earthdata.ipynb
   faq/import_granules.ipynb
   faq/jupyter_server.ipynb
-  faq/request_data.ipynb
+  faq/request_data.ipynb
+  faq/delete_algorithm_from_mas.ipynb
diff --git a/docs/source/system_reference_guide/faq/delete_algorithm_from_mas.ipynb b/docs/source/system_reference_guide/faq/delete_algorithm_from_mas.ipynb
@@ -1,27 +1,38 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "# How Do I Delete My Algorithm From MAS?\n",
     "\n",
-    "Open the *DPS/MAS Operations* menu and select *Delete Algorithm*. \n",
+    "Example of registered algorithm ids:\n",
+    "![registered_algorithms](../../_static/faq_images/algorithm_dropdown.png)\n",
     "\n",
-    "![delete algorithm](../../_static/faq_images/delete_algorithm.png) \n",
+    "The code snippet below will delete an algorithm registered as \"test:develop\".\n",
+    "```python\n",
+    "from maap.maap import MAAP\n",
+    "maap = MAAP(maap_host='api.maap-project.org')\n",
     "\n",
-    "A dropdown list of the currently available algorithms will show up. \n",
+    "algorithm_name = \"test\"\n",
+    "branch = \"develop\"\n",
     "\n",
-    "![select an algorithm to delete](../../_static/faq_images/select_an_algorithm_to_delete.png)\n",
-    "\n",
-    "Select the algorithm you wish to delete and press OK."
+    "# Takes in an algorithm id\n",
+    "maap.deleteAlgorithm(f\"{algorithm_name}:{branch}\")\n",
+    "```"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -35,7 +46,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.8"
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

diff --git a/docs/source/system_reference_guide/faq/register_algorithm_to_mas.ipynb b/docs/source/system_reference_guide/faq/register_algorithm_to_mas.ipynb
diff --git a/docs/source/system_reference_guide/jobs_maappy.ipynb b/docs/source/system_reference_guide/jobs_maappy.ipynb
@@ -36,6 +36,9 @@
     "\n",
     "Use the `submitJob` method and provide your algorithm inputs. The example below will run the `run-dps-test_ubuntu` algorithm.\n",
     "\n",
+    ".. note::\n",
+    "Experimental feature: The output data will be put into a folder named for your `algo_id` and the `identifier`. You can use the same `idenfitier` on several jobs (e.g. in a batch) to group related output data in one place. In the [View & Submit Jobs GUI](jobsui.ipynb#Submit-a-Job) this is the Job Tag field in the Submit form.\n",
+    "\n",
     "```\n",
     "maap.submitJob(identifier=\"test-job\", \n",
     "               algo_id=\"run-dps-test_ubuntu\",\n",

diff --git a/docs/source/system_reference_guide/jobsui.ipynb b/docs/source/system_reference_guide/jobsui.ipynb
@@ -66,9 +66,12 @@
     "\n",
     "Users can submit individual jobs from the __Submit__ pane. The following are the minimum requirements for submitting a job:\n",
     "\n",
-    "1. Select an algorithm from the dropdown menu. Note: only registered algorithms will be shown.\n",
-    "2. Provide a tag that may then be used to easily search for and identify the submitted job.\n",
-    "3. Select the resource to use for algorithm execution.\n",
+    "1. Select an Algorithm from the dropdown menu. Note: only registered algorithms will be shown.\n",
+    "2. Provide a Job Tag that may then be used to easily search for and identify the submitted job. This is the same as the `identifier` field in the maap.py submitJob() function.\n",
+    "3. Select the Resource to use for algorithm execution. This indicates the memory and disk space available.\n",
+    "\n",
+    ".. note::\n",
+    "Experimental feature: The output data will be put into a folder named for your Algorithm and the Job Tag. You can use the same Job Tag on several jobs (e.g. in a batch) to group related output data in one place. In [maap.py submitJob](jobs_maappy.ipynb#Submit-a-Job) this is the `identifier` field when you use submitJob().\n",
     "\n",
     "![jobs_ui_submit](../_static/jobs_ui_submit.png)\n",
     "\n",