Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Periodic merge to master (release 3.1.5) #394

Merged
merged 98 commits into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from 92 commits
Commits
Show all changes
98 commits
Select commit Hold shift + click to select a range
1a4b54e
Added ATL08 access and explore instruction. Need to figure out why it…
Apr 8, 2023
65ae508
chore: update from develop
wildintellect Apr 10, 2023
b9b395f
chore: move tutorial to new science section
wildintellect Apr 10, 2023
6510d58
chore: finish re-organizing atl08 location to science
wildintellect Apr 10, 2023
bbe2f0d
fix: formatting for readability
wildintellect Apr 10, 2023
b1b03ac
initial outline of dps tutorial
rtapella Sep 29, 2023
7f9ba0c
added dps tutorial to the table of contents
rtapella Sep 29, 2023
e1af54a
fix spacing to make bullet lists work
rtapella Sep 29, 2023
9089adb
typos
rtapella Oct 23, 2023
0691ec1
added images
rtapella Oct 24, 2023
f9dfb8c
fixed container path
rtapella Oct 30, 2023
e0582e7
updating to new alg. reg UI
rtapella Nov 1, 2023
fa2c777
updated images for new alg. registration form
rtapella Nov 6, 2023
5aec01e
added job submit and view info
rtapella Nov 7, 2023
5d4f2e0
atl08 updates
smk0033 Nov 10, 2023
77fa386
Add documentation for argparse and testing locally
sujen1412 Nov 13, 2023
f893f35
grammar fix
rtapella Nov 15, 2023
0ec26b2
mention that cloning is optional if you just want to register public …
rtapella Dec 7, 2023
7195f6e
fixing issues from git issue 2
rtapella Dec 7, 2023
4189985
cleanup of some bullet-lists
rtapella Dec 7, 2023
4c1d1df
updated example input file
rtapella Jan 3, 2024
298d908
Add more description for build and run scripts in dps tutrial
sujen1412 Jan 8, 2024
9f4ab45
Add FAQ section
sujen1412 Jan 8, 2024
4a319fb
adding memory profiling docs
omshinde Jan 9, 2024
ffcf187
Add some details about job outputs
sujen1412 Jan 23, 2024
b09bcdc
Merge branch 'develop' of github.com:MAAP-Project/maap-documentation …
grallewellyn Jan 23, 2024
770c1c6
Merge branch 'develop' of github.com:MAAP-Project/maap-documentation …
grallewellyn Jan 31, 2024
93ab561
added note that it isnt recommended to use jupyter notebooks in buckets
grallewellyn Jan 31, 2024
d55839a
Merge branch 'develop' into dps-tutorial-v1
rtapella Jan 31, 2024
18b0890
switched out storage options diagram for Robs copy
grallewellyn Jan 31, 2024
384c3ca
added files suggested to edit in root
grallewellyn Jan 31, 2024
8d7529c
Merge pull request #378 from MAAP-Project/feature/no-notebook-in-bucket
grallewellyn Feb 1, 2024
63a82d7
docs: add zenodo badge
jjfrench Feb 1, 2024
33c4da5
Merge pull request #380 from MAAP-Project/zenodo-badge
smk0033 Feb 1, 2024
7121278
add download instructions for demo file
rtapella Feb 2, 2024
d9bcf1b
update example CLI execution arguments
rtapella Feb 2, 2024
290ddad
added 3.1.4 workspace default
rtapella Feb 2, 2024
5f2ae48
re-ordered the example CLI run for clarity
rtapella Feb 2, 2024
7d1daaa
remove . to make copy-paste easier
rtapella Feb 3, 2024
06a8cc3
updated some intro
rtapella Feb 7, 2024
037f7e9
cleaning up install instructions 1
rtapella Feb 7, 2024
0621b50
cleaning up 2
rtapella Feb 7, 2024
4d4b103
clean up 3
rtapella Feb 7, 2024
ffba707
Addressing review comments
omshinde Feb 7, 2024
58e2e03
Addressing review comments
omshinde Feb 8, 2024
450d5be
Adding index to the rst file
omshinde Feb 8, 2024
26b170f
formatting cleanup
rtapella Feb 8, 2024
814a8c4
fix copy/paste of python command
rtapella Feb 8, 2024
5260211
fixed repo URL
rtapella Feb 8, 2024
ef57c1a
Addressing Review Comments V3
omshinde Feb 9, 2024
9200b73
fixed a bunch of typos/grammar
rtapella Feb 12, 2024
67ae931
Address review comments V4
omshinde Feb 13, 2024
ad7d312
Address review comments V5
omshinde Feb 13, 2024
a0e682d
Merge pull request #371 from MAAP-Project/memory_profiling_docs
omshinde Feb 14, 2024
2928721
visualizations
smk0033 Feb 26, 2024
7658fa0
name update
smk0033 Feb 26, 2024
1395229
rst update
smk0033 Feb 26, 2024
45f6c52
updated s3 command to avoid errors
rtapella Feb 28, 2024
44cafa4
redid all the images for registration and job-submit
rtapella Feb 29, 2024
0640c06
updating order of tutorial and cleanup
smk0033 Mar 4, 2024
116eaa8
some transition text
rtapella Mar 5, 2024
7ef0a22
more updates addressing reviews
smk0033 Mar 7, 2024
4426856
update comments to shift from source -> conda run
rtapella Mar 8, 2024
1e25f15
description and workspace update
smk0033 Mar 8, 2024
8e48612
added cloud native geoguide links
smk0033 Mar 8, 2024
08e0e9f
updates
smk0033 Mar 8, 2024
b8c1d4b
added hysds <-> maap job status mapping
rtapella Mar 12, 2024
e937036
added job-revoked info
rtapella Mar 15, 2024
1162e8b
fixed a section title
rtapella Mar 15, 2024
bcd574b
some reformatting
rtapella Mar 15, 2024
8872ca8
Merge branch 'develop' into atl08
smk0033 Mar 18, 2024
2030e88
Merge pull request #362 from MAAP-Project/atl08
smk0033 Mar 18, 2024
a2d7c55
Merge pull request #385 from MAAP-Project/cog_link_additions
smk0033 Mar 18, 2024
c34da8f
several updates from testing
rtapella Mar 20, 2024
9b67f7a
clarity around the registration process
rtapella Mar 20, 2024
83acbb0
Merge pull request #386 from MAAP-Project/job-status-mapping
rtapella Mar 21, 2024
6cdde74
Merge branch 'develop' of github.com:MAAP-Project/maap-documentation …
grallewellyn Mar 21, 2024
0502e80
added 3.1.5 release notes
grallewellyn Mar 21, 2024
cfda9a9
wording updates
grallewellyn Mar 21, 2024
7c5079c
added line about removing rgedi and isce2 images
grallewellyn Mar 25, 2024
ab807dd
upper-case some bullets
rtapella Mar 29, 2024
579242e
revoke docs | minor updates
marjo-luc Apr 3, 2024
26979c0
removed added item of removing need for maap.cfg because we had to un…
grallewellyn Apr 4, 2024
3731b49
Merge pull request #388 from MAAP-Project/graceal/315_updates
grallewellyn Apr 4, 2024
f717f40
Merge pull request #390 from MAAP-Project/mlucas/revoke-docs
rtapella Apr 8, 2024
2ba5e33
Merge branch 'develop' into dps-tutorial-v1
rtapella Apr 8, 2024
fc7ac48
updated basedir example in docs
rtapella Apr 8, 2024
2d5ca50
added more contributor info
rtapella Apr 8, 2024
e6d17b0
update format of author/review section
rtapella Apr 8, 2024
a9f09d7
Merge pull request #389 from MAAP-Project/dps-tutorial-v1
rtapella Apr 8, 2024
b36dc6d
Merge branch 'develop' of github.com:MAAP-Project/maap-documentation …
grallewellyn Apr 9, 2024
d304a68
Merge branch 'master' into fix-relnotes-315
rtapella Apr 9, 2024
5b5850d
Merge pull request #393 from MAAP-Project/fix-relnotes-315
rtapella Apr 9, 2024
98e995c
Merge branch 'develop' of github.com:MAAP-Project/maap-documentation …
grallewellyn Apr 9, 2024
267c995
changing to less blurry edsc image
grallewellyn Apr 9, 2024
81bd6b0
added granule image
grallewellyn Apr 9, 2024
a916ef4
added import granules image
grallewellyn Apr 9, 2024
3e6c04e
Merge pull request #395 from MAAP-Project/fix-blurry-image
rtapella Apr 9, 2024
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# maap-documentation
[![Documentation Status](https://readthedocs.org/projects/maap-project/badge/?version=latest)](https://maap-project.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/maap-project/badge/?version=latest)](https://maap-project.readthedocs.io/en/latest/?badge=latest) [![DOI](https://zenodo.org/badge/235617200.svg)](https://zenodo.org/doi/10.5281/zenodo.10499174)

This repository serves as the technical documentation for interfacing with the MAAP services.

Expand Down
Binary file added docs/source/_static/jobs_ui/revoke_failed.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 added docs/source/_static/jobs_ui/revoke_job.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 added docs/source/_static/jobs_ui/revoke_successful.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/getting_started/_static/storage_options_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 13 additions & 7 deletions docs/source/getting_started/getting_started.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -136,21 +136,22 @@
"\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",
" - Use this for code-related items, smaller data storage\n",
" - Git is more likely to behave predictably here compared to other storage\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",
" - Uses local (to Jupyter) file system; generally faster and more reliable for “normal” file operations, but expensive\n",
"\n",
"#### Large file storage: my-private-bucket\n",
"`~/my-private-bucket` is an S3 bucket with persistent storage, but accessible only to you and others in a shared workspace.\n",
" \n",
" - Use for large data storage\n",
" - It will be slower than the root folder to copy and move files, which is why it is not ideal for storing smaller files that need to be read or written quickly\n",
" - It will be slower than the root folder to copy and move files, which is why it is not ideal for storing smaller files that need to be read or written quickly (e.g. Jupyter Notebooks)\n",
"\n",
"#### Sharing files: my-public-bucket and shared-buckets\n",
"`~/my-public-bucket` is an S3 bucket with persistent storage. It is the same as `~/shared-buckets/<my_username>/` — anything you put in here will be accessible to other users via `~/shared-buckets/<my_username>` as a read-only file. Likewise, to find shared files from another user, look in `~/shared-buckets/<their_username>`.\n",
"\n",
" - Use for large data storage for files that you want to share across workspaces\n",
" - Use for large data storage for files that you want to share across workspaces \n",
" - Public and shared buckets are not recommended for Jupyter Notebooks\n",
"\n",
"![Storage options diagram](_static/storage_options_diagram.png)\n",
"\n",
Expand All @@ -161,9 +162,9 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python [conda env:root] *",
"display_name": "Python 3.12.0 64-bit",
"language": "python",
"name": "conda-root-py"
"name": "python3"
},
"language_info": {
"codemirror_mode": {
Expand All @@ -175,12 +176,17 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.8"
"version": "3.12.0"
},
"metadata": {
"interpreter": {
"hash": "31f2aee4e71d21fbe5cf8b01ff0e069b9275f58929596ceb00d14d90e3e16cd6"
}
},
"vscode": {
"interpreter": {
"hash": "7500c3e1c7c786e4ba1e4b4eb7588219b4e35d5153674f92eb3a82672b534f6e"
}
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting_started/running_at_scale.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"\n",
"The Jobs UI will let you run and monitor jobs easily. You can find full documentation in the system reference guide for [the Jobs UI](../system_reference_guide/jobsui.ipynb) or [using maap-py](../system_reference_guide/jobs_maappy.ipynb) with Python in the System Reference Guide FAQs.\n",
"\n",
"![job_ui_access](../_static/jobs_ui_access.png)\n",
"![job_ui_access](../_static/jobs_ui/jobs_ui_access.png)\n",
"\n",
"Some alternative methods of running the job are found below.\n",
"\n",
Expand Down
Loading