Skip to content

Commit 16197c7

Browse files
andrewdelmanandrewdelman
committed
Added NASA Earthdata authentication and dataset/variable info to ecco_access intro tutorial
1 parent 595ccf5 commit 16197c7

1 file changed

Lines changed: 72 additions & 2 deletions

File tree

‎ecco_access/ecco_access_tutorials/ECCO_access_intro.ipynb‎

Lines changed: 72 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,17 @@
22
"cells": [
33
{
44
"cell_type": "markdown",
5-
"id": "2802c35d-27c2-44f6-9b85-2c3dcf5d0184",
5+
"id": "e6c4ed67-760b-4a64-9853-5d8eda4112ca",
66
"metadata": {},
77
"source": [
88
"# The *ecco_access* Python \"package\": accessing ECCO output on PO.DAAC\n",
99
"\n",
10-
"Updated 2024-10-17\n",
10+
"Updated 2024-10-18\n",
1111
"\n",
1212
"> Note: The `ecco_access` library is new as of Oct 2024. If you notice bugs or have any questions or suggestions, please feel free to post an issue on the [GitHub](https://github.com/ECCO-GROUP/ECCO-v4-Python-Tutorial/issues) or contact Andrew Delman at andrewdelman@ucla.edu.\n",
1313
"\n",
1414
"[Introduction](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_intro.html#Introduction)\\\n",
15+
"[ECCO output on PO.DAAC](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_intro.html#ECCO-output-on-PO.DAAC)\\\n",
1516
"[Setting up *ecco_access*](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_intro.html#Setting-up-ecco_access)\\\n",
1617
"[Using the *ecco_podaac_to_xrdataset* function](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_intro.html#Using-the-ecco_podaac_to_xrdataset-function)\\\n",
1718
"[What if you don't know the ShortName already?](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_intro.html#What-if-you-don't-know-the-ShortName-already?)\\\n",
@@ -31,7 +32,76 @@
3132
"There are also a number of access modes for querying the datasets, downloading the datasets, or accessing through S3 cloud storage. For more examples of these modes, you can look at the [ECCO access modes](https://ecco-v4-python-tutorial.readthedocs.io/ECCO_access_modes.html) tutorial.\n",
3233
"\n",
3334
"\n",
35+
"## ECCO output on PO.DAAC\n",
3436
"\n",
37+
"### Setting up Earthdata login credentials\n",
38+
"\n",
39+
"An account with NASA Earthdata is required to access ECCO output hosted in the AWS Cloud by PO.DAAC. Please visit [https://urs.earthdata.nasa.gov/home](https://urs.earthdata.nasa.gov/home) to make an account and be ready with your EOSDIS login and password.\n",
40+
"\n",
41+
"*The Earthdata Login provides a single mechanism for user registration and profile management for all EOSDIS system components (DAACs, Tools, Services). Your Earthdata login also helps the EOSDIS program better understand the usage of EOSDIS services to improve user experience through customization of tools and improvement of services. EOSDIS data are openly available to all and free of charge except where governed by international agreements.*\n",
42+
"\n",
43+
"> **Note!** _some Earthdata password characters may cause problems depending on your system_. To be safe, do not use any of the following characters in your password: backslash (\\\\), space, hash (#), quotes (single or double), or greater than (>). Set/change your Earthdata password here: [https://urs.earthdata.nasa.gov/change_password](https://urs.earthdata.nasa.gov/change_password)\n",
44+
"\n",
45+
"\n",
46+
"1. After creating a NASA Earthdata account, create a file called ```.netrc``` in your home directory (linux, Mac):\n",
47+
"```\n",
48+
"/home/<username>/.netrc\n",
49+
"```\n",
50+
"or ```_netrc``` (Windows):\n",
51+
"```\n",
52+
"C:\\Users\\<username>\\_netrc\n",
53+
"```\n",
54+
"\n",
55+
"The ```netrc``` file must have the following structure and must include your Earthdata account login name and password:\n",
56+
"\n",
57+
"```\n",
58+
"machine urs.earthdata.nasa.gov\n",
59+
" login <your username>\n",
60+
" password <your password>\n",
61+
"```\n",
62+
"\n",
63+
"2. Set permissions on your ```netrc``` file to be readable only by the current user. If not, you will receive the error \"netrc access too permissive.\" \n",
64+
"\n",
65+
"```shell\n",
66+
"$ chmod 0600 ~/.netrc\n",
67+
"```\n",
68+
"\n",
69+
"### ECCO output structure on PO.DAAC\n",
70+
"\n",
71+
"On PO.DAAC and in the NASA Earthdata Cloud, ECCO output is organized in the following hierarchy:\n",
72+
"\n",
73+
"- **Dataset:** Typically contains a few variables, spanning the time range of the ECCO v4r4 output (currently 1992-2017). Most datasets are divided (in the time dimension) into hundreds or thousands of granules.\n",
74+
"\n",
75+
" - **Granule:** Dataset variables at a specific time (monthly mean, daily mean, or snapshot). Exceptions are 1-D time series where the entire dataset only consists of one granule.\n",
76+
"\n",
77+
" - **Variable:** A specific geophysical parameter (or flux) representing the state of the ocean, atmosphere, or sea ice/snow cover. Individual variables are not visible through the NASA Earthdata website, but can be seen after a granule file has been opened.\n",
78+
"\n",
79+
"\n",
80+
"Each dataset has a dataset code called a `ShortName` which is used to identify it on the cloud. In order to download particular variable(s), you need to identify the `ShortName` associated with the dataset containing those variables. You can search for the variables in the linked text files below, or download these files for your reference.\n",
81+
"\n",
82+
"### Dataset ShortNames and variables associated with them\n",
83+
"\n",
84+
"[ECCO v4r4 llc90 Grid Dataset Variables - Monthly Means](https://raw.githubusercontent.com/ECCO-GROUP/ECCO-v4-Python-Tutorial/master/varlist/v4r4_nctiles_monthly_varlist.txt)\n",
85+
"\n",
86+
"[ECCO v4r4 llc90 Grid Dataset Variables - Daily Means](https://raw.githubusercontent.com/ECCO-GROUP/ECCO-v4-Python-Tutorial/master/varlist/v4r4_nctiles_daily_varlist.txt)\n",
87+
"\n",
88+
"[ECCO v4r4 llc90 Grid Dataset Variables - Daily Snapshots](https://raw.githubusercontent.com/ECCO-GROUP/ECCO-v4-Python-Tutorial/master/varlist/v4r4_nctiles_snapshots_varlist.txt)\n",
89+
"\n",
90+
"[ECCO v4r4 0.5-Deg Interp Grid Dataset Variables - Monthly Means](https://raw.githubusercontent.com/ECCO-GROUP/ECCO-v4-Python-Tutorial/master/varlist/v4r4_latlon_monthly_varlist.txt)\n",
91+
"\n",
92+
"[ECCO v4r4 0.5-Deg Interp Grid Dataset Variables - Daily Means](https://raw.githubusercontent.com/ECCO-GROUP/ECCO-v4-Python-Tutorial/master/varlist/v4r4_latlon_daily_varlist.txt)\n",
93+
"\n",
94+
"[ECCO v4r4 Time Series and Grid Parameters](https://raw.githubusercontent.com/ECCO-GROUP/ECCO-v4-Python-Tutorial/master/varlist/v4r4_tseries_grid_varlist.txt)\n",
95+
"\n",
96+
"\n",
97+
"Note that unlike earlier releases of ECCO v4, in v4r4 all monthly mean variables are also available for download as daily means. Snapshots (typically at daily intervals) are available for a few variables, and can be used to help close budgets as shown in later tutorials."
98+
]
99+
},
100+
{
101+
"cell_type": "markdown",
102+
"id": "84e3f907-eeef-4dc0-8cfb-b5df5ef82d21",
103+
"metadata": {},
104+
"source": [
35105
"## Setting up `ecco_access`\n",
36106
"\n",
37107
"The *ecco_access* library I am calling a \"package\" in quotes because it currently has the core structure of any package you would install using `conda` or `pip`; there is an `__init__.py` file that allows you to access all of the library's modules and the functions within, using a single `import ecco_access` command. However, this \"package\" is not available through `conda` or `pip` yet. In the meantime, you can get `ecco_access` using one of the following methods:\n",

0 commit comments

Comments
 (0)