-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathearthdata.html
More file actions
218 lines (197 loc) · 12.6 KB
/
earthdata.html
File metadata and controls
218 lines (197 loc) · 12.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>NASA Earth Data Login — 3.2.0+3.gb2780d4a</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.png"/>
<link rel="canonical" href="https://podpac.org/earthdata.html" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="AWS Development" href="aws-development.html" />
<link rel="prev" title="Interpolation" href="interpolation.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html">
<img src="_static/icon.svg" class="logo" alt="Logo"/>
</a>
<div class="version">
3.2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws.html">AWS Integration</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Topics</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="why-podpac.html">Why PODPAC?</a></li>
<li class="toctree-l1"><a class="reference internal" href="design.html">Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="nodes.html">Nodes</a></li>
<li class="toctree-l1"><a class="reference internal" href="coordinates.html">Coordinates</a></li>
<li class="toctree-l1"><a class="reference internal" href="cache.html">Cache</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html">Supported Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="interpolation.html">Interpolation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">NASA Earth Data Login</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#motivation">Motivation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#creating-an-earthdata-login-account">Creating an Earthdata Login Account</a></li>
<li class="toctree-l2"><a class="reference internal" href="#using-earthdata-credentials-in-podpac">Using Earthdata Credentials in PODPAC</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="aws-development.html">AWS Development</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">References</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="wrapping-datasets.html">Wrapping Datasets</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Support</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="roadmap.html">Development Roadmap</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PODPAC</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">NASA Earth Data Login</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/earthdata.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="nasa-earth-data-login">
<h1>NASA Earth Data Login<a class="headerlink" href="#nasa-earth-data-login" title="Permalink to this heading"></a></h1>
<p>This document describes using an Earth Data Account with PODPAC.</p>
<section id="motivation">
<h2>Motivation<a class="headerlink" href="#motivation" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>An Earth Data Login account is needed to access the wealth of data provided by
NASA.</p></li>
<li><p>PODPAC automatically retrieves this data using OpenDAP.</p></li>
<li><p>OpenDAP needs an authenticated session to retrieve the data.</p></li>
<li><p>To set up an authenticated session, a user can:</p>
<ul>
<li><p>save their credentials as part of a PODPAC settings files</p></li>
<li><p>provide their username and password to the child class of a PyDAP node at runtime</p></li>
</ul>
</li>
</ul>
</section>
<section id="creating-an-earthdata-login-account">
<h2>Creating an Earthdata Login Account<a class="headerlink" href="#creating-an-earthdata-login-account" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>Go to the <a class="reference external" href="https://urs.earthdata.nasa.gov/users/new">Earthdata Registration Page</a>
page and follow the instructions to register an account</p></li>
<li><p>Go to the <a class="reference external" href="https://urs.earthdata.nasa.gov/">Earthdata Login Page</a> to log into
your account</p></li>
<li><p>To enable OpenDAP access:</p>
<ul>
<li><p>Go to your <a class="reference external" href="https://urs.earthdata.nasa.gov/profile">Profile</a> once logged in.</p></li>
<li><p>Under <code class="docutils literal notranslate"><span class="pre">Applications</span></code>, click on <code class="docutils literal notranslate"><span class="pre">Authorized</span> <span class="pre">Apps</span></code></p></li>
<li><p>Scroll to the bottom and click on <code class="docutils literal notranslate"><span class="pre">APPROVE</span> <span class="pre">MORE</span> <span class="pre">APPLICATIONS</span></code></p></li>
<li><p>Find the <code class="docutils literal notranslate"><span class="pre">NASA</span> <span class="pre">GESDICS</span> <span class="pre">DATA</span> <span class="pre">ARCHIVE</span></code>, <code class="docutils literal notranslate"><span class="pre">NSIDC</span> <span class="pre">V0</span> <span class="pre">OPeNDAP</span></code>, and <code class="docutils literal notranslate"><span class="pre">NSIDC_DATAPOOL_OPS</span></code> applications</p>
<ul>
<li><p>Additional applications may be required to access datasets of interest</p></li>
</ul>
</li>
<li><p>For each, click the <code class="docutils literal notranslate"><span class="pre">APPROVE</span></code> button</p></li>
</ul>
</li>
<li><p>At this stage, your Earthdata account should be set up and ready to use for
accessing data through OpenDAP</p></li>
</ul>
</section>
<section id="using-earthdata-credentials-in-podpac">
<h2>Using Earthdata Credentials in PODPAC<a class="headerlink" href="#using-earthdata-credentials-in-podpac" title="Permalink to this heading"></a></h2>
<p>PODPAC uses Earthdata credentials to access the SMAP data source nodes.
You can store the credentials for SMAP nodes using the <code class="docutils literal notranslate"><span class="pre">Node</span></code> method <code class="docutils literal notranslate"><span class="pre">set_credentials</span></code>.</p>
<p>To store credentials for SMAP nodes, use the following code in an interactive Python session:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">podpac.datalib</span> <span class="kn">import</span> <span class="n">SMAP</span>
<span class="n">node</span> <span class="o">=</span> <span class="n">SMAP</span><span class="p">()</span>
<span class="n">node</span><span class="o">.</span><span class="n">set_credentials</span><span class="p">(</span><span class="n">username</span><span class="o">=</span><span class="s2">"<earthdata-username>"</span><span class="p">,</span> <span class="n">password</span><span class="o">=</span><span class="s2">"<earthdata-password>"</span><span class="p">)</span>
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">set_credentials</span></code> method stores credentials for a Node in the PODPAC settings.
To persistently save the credentials in the PODPAC settings
(to avoid running <code class="docutils literal notranslate"><span class="pre">set_credentials</span></code> at runtime or in a script), run <code class="docutils literal notranslate"><span class="pre">settings.save()</span></code>:</p>
<blockquote>
<div><p><strong>NOTE:</strong> PODPAC stores credentials in plain text.
Be conscious of outputting the PODPAC settings to a file when it contains credentials.</p>
</div></blockquote>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">podpac</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="n">settings</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
</pre></div>
</div>
<p>Your credentials will be saved in <code class="docutils literal notranslate"><span class="pre">$HOME\.podpac\settings.json</span></code>
where <code class="docutils literal notranslate"><span class="pre">$HOME</span></code> is usually <code class="docutils literal notranslate"><span class="pre">C:\users\<USERNAME></span></code> on Windows and <code class="docutils literal notranslate"><span class="pre">/home/<USERNAME></span></code>
on Linux systems.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="interpolation.html" class="btn btn-neutral float-left" title="Interpolation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="aws-development.html" class="btn btn-neutral float-right" title="AWS Development" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2017-2023, Creare.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>