Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
ef5ec74
Create docs/source/science/GEE folder (.gitkeep)
HarshiniGirish Oct 1, 2025
c226c67
fm embedding
HarshiniGirish Oct 1, 2025
5693d21
Delete docs/source/science/GEE/.gitkeep
HarshiniGirish Oct 1, 2025
aed6375
Create EarthCare_access and_visualize.ipynb
HarshiniGirish Oct 15, 2025
132a280
Update EarthCare_access and_visualize.ipynb
HarshiniGirish Oct 15, 2025
ac991fb
addressed comments
HarshiniGirish Oct 15, 2025
dd048a8
Rename EarthCare_access and_visualize.ipynb to EarthCARE_access_and_v…
HarshiniGirish Oct 15, 2025
431a4b2
add Earthcare
HarshiniGirish Oct 16, 2025
422d99d
addressed comments
HarshiniGirish Oct 16, 2025
904c441
Merge pull request #527 from HarshiniGirish/EarthCARE
HarshiniGirish Oct 16, 2025
c7aacf4
ORNL and PODAAC update
HarshiniGirish Oct 16, 2025
689c178
Merge pull request #528 from HarshiniGirish/direct-access
HarshiniGirish Oct 16, 2025
578220e
Update OPERA_Surface_Displacement.ipynb
HarshiniGirish Oct 20, 2025
df91808
addressed comment
HarshiniGirish Oct 20, 2025
9cddaf8
Merge pull request #529 from HarshiniGirish/opera-dps
HarshiniGirish Oct 20, 2025
d0a58d8
added visualization
HarshiniGirish Oct 27, 2025
0f1b798
Addressed comments
HarshiniGirish Nov 4, 2025
d755143
Merge pull request #522 from HarshiniGirish/google-earth-embedding
HarshiniGirish Nov 6, 2025
a6c8936
add alpha earth rst
HarshiniGirish Nov 6, 2025
61f94dc
Merge pull request #533 from HarshiniGirish/alphaearth
HarshiniGirish Nov 6, 2025
659f4ac
feat: outline new guide to disk types and usage
wildintellect Nov 25, 2025
7807097
feat: split into subsections, add more details
wildintellect Dec 5, 2025
6755aa1
fix: refined details and example
wildintellect Dec 5, 2025
2ce7879
feat: ADE to Hub notes
wildintellect Dec 5, 2025
48c763b
fix: minor adjustments
wildintellect Dec 5, 2025
c1893f8
feat: get started by contacting support
wildintellect Dec 5, 2025
e4217f6
external_access_from_hub
HarshiniGirish Dec 8, 2025
73817f2
Merge branch 'maap-hub-docs' of github.com:MAAP-Project/maap-document…
grallewellyn Dec 8, 2025
cd353dc
initial commit for 2i2c overview
grallewellyn Dec 8, 2025
a4abf5b
added instructions for multiple servers
grallewellyn Dec 8, 2025
a922a45
added link to hub to add new server
grallewellyn Dec 8, 2025
f01f9c7
fix: edits based on review
wildintellect Dec 8, 2025
159bc3f
Updated as per comments
HarshiniGirish Dec 12, 2025
5f8328e
added navigation
HarshiniGirish Dec 12, 2025
1ad471d
fix: more explanation of what this guide is
wildintellect Dec 15, 2025
e358a62
transitioned docs from eclipse che to 2i2c
grallewellyn Dec 16, 2025
f8e8778
fix: delete blank cell
wildintellect Dec 16, 2025
9cc6098
Merge pull request #534 from MAAP-Project/feat/disk-guide
wildintellect Dec 16, 2025
9d9299b
updated with Alex suggestions
grallewellyn Dec 16, 2025
7b78c31
Merge branch 'maap-hub-docs' of github.com:MAAP-Project/maap-document…
grallewellyn Dec 16, 2025
e792bee
fixed merge conflicts
grallewellyn Dec 16, 2025
b77e3c6
readded updating with environment.yml and bringing your own image docs
grallewellyn Dec 17, 2025
5f4e702
removed persistent environment docs
grallewellyn Dec 17, 2025
2328cbd
Merge pull request #537 from MAAP-Project/2i2c-overview
grallewellyn Dec 17, 2025
3cfd8ba
added repo2docker example MAAP images
grallewellyn Dec 17, 2025
9638097
Merge pull request #544 from MAAP-Project/2i2c-overview
grallewellyn Dec 17, 2025
456b351
removed use of CHE_WORKSPACE_NAMESPACE and changed R/Python and chang…
grallewellyn Jan 5, 2026
5ed7775
finished changing mentions of /projects to /home/jovyan
grallewellyn Jan 5, 2026
72d057f
fixed typo
grallewellyn Jan 27, 2026
b3d0508
Merge pull request #547 from MAAP-Project/tutorials-2i2c-updates
grallewellyn Jan 27, 2026
d7a983d
updated pangeo and R descriptions
grallewellyn Feb 12, 2026
a631c2f
reworded R image
grallewellyn Feb 12, 2026
254c06f
reworded MAAP extensions
grallewellyn Feb 12, 2026
7438a93
added QGIS and GPU images and note about extending existing environments
grallewellyn Feb 12, 2026
c0dbfc5
moved important note to after extending environment
grallewellyn Feb 12, 2026
a4d28ce
Merge pull request #561 from MAAP-Project/update-image-descriptions
grallewellyn Feb 13, 2026
829fdc7
pointing to VEDA docs
grallewellyn Mar 5, 2026
aa3e9de
removed hyperlinks
grallewellyn Mar 5, 2026
4645f4c
Merge pull request #567 from MAAP-Project/update-ssh-docs
grallewellyn Mar 5, 2026
377d87d
Clarify AWS credentials access and usage in docs
bsatoriu Mar 13, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed docs/source/_static/access_denied.png
Binary file not shown.
Binary file added docs/source/_static/add_server_2i2c.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/clone_demo3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/clone_demo5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/clone_demo6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/clone_demo7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/getting_started/_static/ade_login.png
Binary file not shown.
Binary file removed docs/source/getting_started/_static/createws3.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/getting_started/_static/interface2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/getting_started/_static/loggingin1.png
Binary file not shown.
Binary file removed docs/source/getting_started/_static/loggingin3.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 25 additions & 28 deletions docs/source/getting_started/getting_started.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,14 @@
"source": [
"### Signing up for a new MAAP account\n",
"\n",
"Once registered, you can register for a MAAP account by navigating to the MAAP ADE at http://ade.maap-project.org. On your first visit, select the \"Login with EarthData Account\" button shown here:\n",
"Once registered, you can register for a MAAP account by navigating to the MAAP Hub at https://hub.maap-project.org/. On your first visit, select the \"Login with EarthData Account\" button shown here:\n",
"\n",
"![ADE Login](_static/ade_login.png) \n",
" \n",
"\n",
"This is your first visit to the MAAP, so you will be asked to agree to the MAAP Terms of Use:\n",
"\n",
"![MAAP Terms of Use](../_static/tou.png) \n",
" \n",
"\n",
"Once registered, you should be redirected back to the MAAP ADE showing a disabled account message similar to this:\n",
"![Hub Login](_static/hub_login.png) \n",
"\n",
"![ADE Access Denied](../_static/access_denied.png) \n",
"Once registered, you will be redirect to this page \n",
"![Requested Account](_static/requested_account.png) \n",
" \n",
" \n",
"At this point, a MAAP administrator will approve your account, which will grant you access to the MAAP ADE. **Remember, access is only granted to known users in the biomass science community and other projects directly related to MAAP**. To check on the status of your pending account, contact the MAAP team at support@maap-project.org.\n",
"At this point, a MAAP administrator will approve your account, which will grant you access to the MAAP Hub. **Remember, access is only granted to known users in the biomass science community and other projects directly related to MAAP**. To check on the status of your pending account, contact the MAAP team at support@maap-project.org.\n",
"\n",
".. note::\n",
" Once your MAAP account is approved, you will receive an email notification using the address of your Earthdata Login account to let you know that your access is enabled."
Expand All @@ -57,16 +49,15 @@
"source": [
"### Logging in\n",
"\n",
"1. Navigate to https://ade.maap-project.org/ in Chrome or Firefox. You should be redirected to a page that looks like this:\n",
"![MAAP Project log in](_static/loggingin1.png)\n",
"\n",
"1. Navigate to https://hub.maap-project.org/ in Chrome or Firefox. You should be redirected to a page that looks like this:\n",
"![Hub Login](_static/hub_login.png)\n",
"\n",
"2. Click the “Login with EarthData Account” button. If this is your first time logging in, you should be redirected to an EarthData Login page that looks like this:\n",
"2. Click the \"Sign in with EarthData Login” button. If this is your first time logging in, you should be redirected to an EarthData Login page that looks like this:\n",
"![Login with EarthData](_static/loggingin2.png)\n",
"\n",
"\n",
"3. Enter your “EarthData Login” account credentials here and click “Log in”. You should see a temporary page that says “Redirecting”, followed by the MAAP showing your Workspaces (which will be empty to start):\n",
"![MAAP Jupyter logging in](_static/loggingin3.png)"
"3. Enter your “EarthData Login” account credentials here and click “Log in”. You should see a temporary page that says “Redirecting”, followed by the MAAP Hub launch page:\n",
"![MAAP Jupyter logging in](_static/hub_launch_page.png)"
]
},
{
Expand All @@ -78,19 +69,25 @@
"\n",
"Workspaces are effectively a JupyterLab \"computer in the cloud\". To get started with Jupyter you need to create a workspace.\n",
"\n",
".. note::\n",
"In MAAP workspaces v4.0.0 the vanilla workspace was renamed to python. The associated Stack name changed as well, from Basic Stable to Python (default).\n",
"Overview of our images:\n",
"- Pangeo image: Built from Pangeo notebook image: https://github.com/pangeo-data/pangeo-docker-images/blob/master/pangeo-notebook/environment.yml \n",
"- isce3 image: Built from Pangeo base notebook with these packages installed: https://github.com/MAAP-Project/maap-workspaces/blob/main/base_images/2i2c/isce3/environment.yml \n",
"- R image: A couple Python packages: https://github.com/MAAP-Project/maap-workspaces/blob/main/base_images/2i2c/r/environment.yml and these R packages installed with CRAN or R universe: https://github.com/MAAP-Project/maap-workspaces/blob/main/base_images/2i2c/r/scripts/install_cran_packages_r.sh \n",
"\n",
"1. Select an image to launch. If you are not sure what image you want, we recommend you start with the \"Modified Pangeo Notebook\" image. You can configure your resource allocation here. You need at least 14.8GB RAM to use conda \n",
"![Hub Launch Page](_static/hub_launch_page.png)\n",
"\n",
"\n",
"1. In the top-left corner of the MAAP dashboard, under “NASA MAAP”, click “Get Started”. You should see a menu that looks like this:\n",
"![Choose a workspace stack](_static/createws1.png)\n",
"2. After choosing your image, you will see a loading screen – wait for it to finish loading.\n",
"\n",
"\n",
"2. Select \"Python (default)\". This is called a \"Stack\" and represents a type of cloud compute environment that will be set up. If you are interested in seeing more about each Stack, the \"Stacks\" section-link in the left-hand area is where you can see the configuration of each Stack in detail. After choosing \"Python (default)\", you will see a loading screen that looks like this – wait for it to finish loading.\n",
"![Loading the Python Stack](_static/createws2.png)\n",
"3. Once the workspace has loaded, you should see a Jupyter interface that looks like this \n",
"![New Workspace View](_static/hub_workspace_view.png)\n",
"\n",
"Access the Hub Control panel from an active workspace by File -> Hub Control Panel. From here you can launch a new workspace \n",
"![Hub Control Panel](_static/hub_control_panel.png)\n",
"\n",
"3. Once the workspace has loaded, you should see a Jupyter interface that looks like this (note: You will see fewer environments and items in your root directory — this is normal! You may also see some notifications in the bottom right that look like errors about SSH Keys and other things; that is normal as well. You will also see one asking if you would like to take a guided tour.).\n",
"![New Workspace View](_static/createws3.png)\n"
"More information about JupyterHub: https://jupyterhub.readthedocs.io/en/stable/tutorial/index.html#getting-started \n"
]
},
{
Expand Down Expand Up @@ -140,7 +137,7 @@
"![Jupyter annotated folders](_static/storageoptions.png)\n",
"\n",
"#### My root folder (fast cloud storage)\n",
" - Your Jupyter home directory (`~`) is mounted to `/projects`. Files in here persist across sessions and exist across your workspaces.\n",
" - Your Jupyter home directory (`~`) is mounted to `/home/jovyan`. Files in here persist across sessions and exist across your workspaces.\n",
" - Use this for code-related items, smaller data storage (such as Jupyter Notebooks, Python/ R/ Markdown files, etc.)\n",
" - Git is more likely to behave predictably here compared to other storage \n",
" - This is also the place to make persistent conda environments (covered in another section), but make sure to not make a conda env inside a git-tracked folder, or if you do add it to the .gitignore. If git is tracking an env, it could cause your workspace to crash. \n",
Expand Down
4 changes: 2 additions & 2 deletions docs/source/getting_started/writing_code.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Testing an Algorithm the Workspace\n",
"## Testing an Algorithm in the Workspace\n",
"\n",
"To make sure that an Algorithm is functioning as expected, we can run it in the Jupyter terminal in a way to mimic how the scaled DPS (Data Processing System) will run it.\n",
"\n",
Expand Down Expand Up @@ -122,7 +122,7 @@
"Testing writing output product\n",
"Testing opening input file\n",
"Traceback (most recent call last):\n",
" File \"/projects/algorithms/dps_unit_test/dps-unit-test/test-input-file.py\", line 6, in <module>\n",
" File \"/home/jovyan/algorithms/dps_unit_test/dps-unit-test/test-input-file.py\", line 6, in <module>\n",
" input_file = sys.argv[1]\n",
" ~~~~~~~~^^^\n",
"IndexError: list index out of range\n",
Expand Down
14 changes: 7 additions & 7 deletions docs/source/science/AfriSAR/AfriSAR_AGB.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@
},
{
"cell_type": "code",
"execution_count": 72,
"execution_count": null,
"id": "af7bfc53-8262-4e99-854f-f67c185d4da0",
"metadata": {
"tags": []
Expand All @@ -399,8 +399,8 @@
" return boto3_session.client(\"s3\")\n",
"\n",
"def download_s3_file(s3, bucket, collection_name, file_name):\n",
" os.makedirs(\"/projects/afrisar\", exist_ok=True) # create directories, as necessary\n",
" download_path=f\"/projects/afrisar/{file_name}.tif\"\n",
" os.makedirs(\"/home/jovyan/afrisar\", exist_ok=True) # create directories, as necessary\n",
" download_path=f\"/home/jovyan/afrisar/{file_name}.tif\"\n",
" s3.download_file(bucket, f\"afrisar/{collection_name}/data/{file_name}.tif\", download_path)\n",
" return download_path"
]
Expand All @@ -420,7 +420,7 @@
},
{
"cell_type": "code",
"execution_count": 74,
"execution_count": 4,
"id": "0712cd4b-28f4-4dd8-b777-ff0b12603852",
"metadata": {
"tags": []
Expand All @@ -429,10 +429,10 @@
{
"data": {
"text/plain": [
"'/projects/afrisar/Rabi_AGB_50m.tif'"
"'/home/jovyan/afrisar/Rabi_AGB_50m.tif'"
]
},
"execution_count": 74,
"execution_count": 4,
"metadata": {},
"output_type": "execute_result"
}
Expand Down Expand Up @@ -1038,7 +1038,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.8"
"version": "3.14.2"
}
},
"nbformat": 4,
Expand Down
14 changes: 4 additions & 10 deletions docs/source/science/ESA_CCI/ESA_CCI_V5_Token_Access.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -116,24 +116,18 @@
},
{
"cell_type": "code",
"execution_count": 2,
"execution_count": 1,
"id": "ba679db0-5603-47ae-83bb-1e9e8e59314a",
"metadata": {
"tags": []
},
"outputs": [
{
"name": "stdin",
"output_type": "stream",
"text": [
"Paste ESA portal token (hidden): ········\n"
]
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"Token loaded from file: /projects/.config/esa_maap/tokenss\n"
"Paste ESA portal token (hidden): ········\n",
"Token loaded from file: /home/jovyan/.config/esa_maap/tokenss\n"
]
}
],
Expand Down Expand Up @@ -483,7 +477,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.13"
"version": "3.14.2"
}
},
"nbformat": 4,
Expand Down
Loading