Skip to content

Commit 1ffb914

Browse files
committed
improved formatting of table of contents at top of tutorial
1 parent 5437f2c commit 1ffb914

File tree

1 file changed

+14
-23
lines changed

1 file changed

+14
-23
lines changed

ecco_access/ecco_access_tutorials/ECCO_access_modes.ipynb

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,20 @@
1111
"\n",
1212
"[Introduction](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#introduction)\n",
1313
"\n",
14-
"[Query-only modes](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#query-only-modes)\n",
14+
"[Query-only modes](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#query-only-modes)\\\n",
15+
"[*ls*/*query* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#ls/query-mode)\\\n",
16+
"[*s3_ls*/*s3_query* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#s3-ls/s3-query-mode)\n",
1517
"\n",
16-
"- [*ls*/*query* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#ls/query-mode)\n",
18+
"[Direct download modes](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#direct-download-modes)\\\n",
19+
"[*download* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#download-mode)\\\n",
20+
"[*download_ifspace* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#download-ifspace-mode)\\\n",
21+
"[*download_subset* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#download-subset-mode)\n",
1722
"\n",
18-
"- [*s3_ls*/*s3_query* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#s3-ls/s3-query-mode)\n",
19-
"\n",
20-
"[Direct download modes](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#direct-download-modes)\n",
21-
"\n",
22-
"- [*download* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#download-mode)\n",
23-
"\n",
24-
"- [*download_ifspace* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#download-ifspace-mode)\n",
25-
"\n",
26-
"- [*download_subset* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#download-subset-mode)\n",
27-
"\n",
28-
"[In-cloud only access modes](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#in-cloud-only-access-modes)\n",
29-
"\n",
30-
"- [*s3_open* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#s3-open-mode)\n",
31-
"\n",
32-
"- [*s3_open_fsspec* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#s3-open-fsspec-mode)\n",
33-
"\n",
34-
"- [*s3_get* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#s3-get-mode)\n",
35-
"\n",
36-
"- [*s3_get_ifspace* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#s3-get-ifspace-mode)\n",
23+
"[In-cloud only access modes](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#in-cloud-only-access-modes)\\\n",
24+
"[*s3_open* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#s3-open-mode)\\\n",
25+
"[*s3_open_fsspec* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#s3-open-fsspec-mode)\\\n",
26+
"[*s3_get* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#s3-get-mode)\\\n",
27+
"[*s3_get_ifspace* mode](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#s3-get-ifspace-mode)\n",
3728
"\n",
3829
"[Time comparison of access modes](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html#time-comparison-of-access-modes)\n",
3930
"\n",
@@ -42,7 +33,7 @@
4233
"\n",
4334
"In the [previous tutorial](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_intro.html) the **ecco_access** library was introduced, with a few examples of how it can be used to search and access ECCOv4 output available from PO.DAAC. This tutorial summarizes and compares the various modes that **ecco_access** supports for HTTPS and (in-cloud) S3 data access. We'll use each mode to search/download/retrieve native grid monthly SSH and wind stress datasets for 6 months (Jan-Jun 2010).\n",
4435
"\n",
45-
"As the [time comparison](#time-comparison-of-access-modes) at the end will show, mode = `s3_open_fsspec` is typically fastest when working in the cloud and you have the necessary `json` files available."
36+
"As the [time comparison](#time-comparison-of-access-modes) at the end will show, mode = `s3_open_fsspec` is typically fastest when working in the cloud and you have the necessary JSON files available."
4637
]
4738
},
4839
{
@@ -6012,7 +6003,7 @@
60126003
"- `s3_get_ifspace`: 12.3 s (similar to `s3_open` because files were opened remotely)\n",
60136004
"\n",
60146005
"\n",
6015-
"These numbers will vary depending on the size and layout of the dataset(s) requested. But the \"winning\" mode on the AWS Cloud is usually `s3_open_fsspec` if you have access to the necessary json files, followed by `s3_get` or `s3_get_ifspace`. Feel free to experiment; changing the access mode is as easy as changing the `mode` parameter in the `ecco_podaac_to_xrdataset` or `ecco_podaac_access` functions!"
6006+
"These numbers will vary depending on the size and layout of the dataset(s) requested. But the \"winning\" mode on the AWS Cloud is usually `s3_open_fsspec` if you have access to the necessary JSON files, followed by `s3_get` or `s3_get_ifspace`. Feel free to experiment; changing the access mode is as easy as changing the `mode` parameter in the `ecco_podaac_to_xrdataset` or `ecco_podaac_access` functions!"
60166007
]
60176008
}
60186009
],

0 commit comments

Comments
 (0)