-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsettings.html
More file actions
310 lines (275 loc) · 17.8 KB
/
settings.html
File metadata and controls
310 lines (275 loc) · 17.8 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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
<!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>Settings — 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/settings.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="Examples" href="examples.html" />
<link rel="prev" title="Installation" href="install.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 class="current">
<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 current"><a class="current reference internal" href="#">Settings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#view-settings">View Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#edit-settings">Edit Settings</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#as-a-dictionary">As a Dictionary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#as-a-json-file">As a JSON file</a></li>
</ul>
</li>
</ul>
</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>
<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"><a class="reference internal" href="earthdata.html">NASA Earth Data Login</a></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">Settings</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/settings.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="settings">
<h1>Settings<a class="headerlink" href="#settings" title="Permalink to this heading"></a></h1>
<p>This tutorial describes methods for viewing and editing PODPAC settings used to configure the features of the library.</p>
<p>To follow along, open a Python interpreter or Jupyter notebook in the Python environment where PODPAC is installed.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># activate the PODPAC environment, using anaconda</span>
$ conda activate podpac
<span class="c1"># open jupyter lab</span>
$ jupyter lab
<span class="c1"># or start a ipython interpreter</span>
$ ipython
</pre></div>
</div>
<section id="view-settings">
<h2>View Settings<a class="headerlink" href="#view-settings" title="Permalink to this heading"></a></h2>
<p>PODPAC settings are accessed through the <code class="docutils literal notranslate"><span class="pre">podpac.settings</span></code> module.
Import the settings module:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [1]: from podpac import settings
</pre></div>
</div>
<p>The settings are stored in a dictionary format, accessible in the interpreter:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [2]: settings
Out[2]:
{'DEBUG': False,
'ROOT_PATH': 'C:\\Users\\user\\.config\\podpac',
'AUTOSAVE_SETTINGS': False,
...
}
</pre></div>
</div>
<p>To view the default settings, view <code class="docutils literal notranslate"><span class="pre">settings.defaults</span></code>:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [3]: settings.defaults
Out[3]:
{'DEBUG': False,
'ROOT_PATH': 'C:\\Users\\user\\.config\\podpac',
'AUTOSAVE_SETTINGS': False,
...
}
</pre></div>
</div>
<p>For documentation on individual PODPAC settings, view the <code class="docutils literal notranslate"><span class="pre">podpac.settings</span></code> module docstring:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [1]: from podpac import settings
In [2]:print(settings.__doc__)
Persistently stored podpac settings
Podpac settings are persistently stored in...
</pre></div>
</div>
</section>
<section id="edit-settings">
<h2>Edit Settings<a class="headerlink" href="#edit-settings" title="Permalink to this heading"></a></h2>
<p>PODPAC settings can be edited multiple ways:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#as-a-dictionary"><span class="xref myst">As a dictionary</span></a>: For interactive and dynamic changes</p></li>
<li><p><a class="reference internal" href="#as-a-json-file"><span class="xref myst">As a JSON file</span></a>: For consistent configurations across installations</p></li>
</ul>
<section id="as-a-dictionary">
<h3>As a Dictionary<a class="headerlink" href="#as-a-dictionary" title="Permalink to this heading"></a></h3>
<p>Since the <code class="docutils literal notranslate"><span class="pre">podpac.settings</span></code> module is a dictionary, the simplest way to edit settings is to directly set values:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [1]: from podpac import settings
In [2]: settings["DEBUG"] = True
In [3]: settings["CACHE_OUTPUT_DEFAULT"] = False
</pre></div>
</div>
<p>These changed settings will only be active for current interpreter session (or script).
Close and reopen a new interpreter session and you will see the settings values are back to default:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [1]: from podpac import settings
In [2]: settings["DEBUG"]
Out[2]: False
</pre></div>
</div>
<p>To persistently save changes to <code class="docutils literal notranslate"><span class="pre">settings</span></code> values, run <code class="docutils literal notranslate"><span class="pre">settings.save()</span></code> after making changes:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [1]: from podpac import settings
In [2]: settings["DEBUG"] = True
In [3]: settings.save()
</pre></div>
</div>
<p>To auto-save settings on <em>any</em> changes, set the <code class="docutils literal notranslate"><span class="pre">settings["AUTOSAVE_SETTINGS"]</span></code> value to <code class="docutils literal notranslate"><span class="pre">True</span></code>:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [1]: from podpac import settings
In [2]: settings["AUTOSAVE_SETTINGS"] = True
</pre></div>
</div>
<p>To reset settings to defaults, call the <code class="docutils literal notranslate"><span class="pre">settings.reset()</span></code> method.
To persistently reset defaults, call the <code class="docutils literal notranslate"><span class="pre">settings.save()</span></code> method after calling <code class="docutils literal notranslate"><span class="pre">settings.reset()</span></code>:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [1]: from podpac import settings
In [2]: settings.reset()
In [3]: settings.save() # to persistently reset defaults
</pre></div>
</div>
</section>
<section id="as-a-json-file">
<h3>As a JSON file<a class="headerlink" href="#as-a-json-file" title="Permalink to this heading"></a></h3>
<p>PODPAC settings can be pre-configured by creating a custom <code class="docutils literal notranslate"><span class="pre">settings.json</span></code> file.</p>
<p>Create a <code class="docutils literal notranslate"><span class="pre">settings.json</span></code> file in the current working directory:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="nt">"DEBUG"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"S3_BUCKET_NAME"</span><span class="p">:</span><span class="w"> </span><span class="s2">"podpac-bucket"</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
<p>Open a new interpreter and load the <code class="docutils literal notranslate"><span class="pre">podpac.settings</span></code> module to see the overwritten values:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [1]: from podpac import settings
In [2]: settings["DEBUG"]
Out[2]: True
</pre></div>
</div>
<p>This file can also be placed in the the PODPAC root directory.
To see the PODPAC root directory, view <code class="docutils literal notranslate"><span class="pre">settings["ROOT_PATH"]</span></code>:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [1]: from podpac import settings
In [2]: settings["ROOT_PATH"]
Out[5]: 'C:\\Users\\user\\.config\\podpac'
</pre></div>
</div>
<p>Edit the <code class="docutils literal notranslate"><span class="pre">settings.json</span></code> file in the <code class="docutils literal notranslate"><span class="pre">"ROOT_PATH"</span></code> location, then open a new interpreter and load the <code class="docutils literal notranslate"><span class="pre">podpac.settings</span></code> module to see the overwritten values:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="nt">"DISK_CACHE_MAX_BYTES "</span><span class="p">:</span><span class="w"> </span><span class="mf">1e9</span><span class="p">,</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span>In [1]: from podpac import settings
In [2]: settings["DISK_CACHE_MAX_BYTES"]
Out[2]: 1000000000.0
</pre></div>
</div>
<p>If a <code class="docutils literal notranslate"><span class="pre">settings.json</span></code> files exist in multiple places, PODPAC will load settings in the following order,
overwriting previously loaded settings (lower numbered items) in the process:</p>
<ol class="arabic simple">
<li><p>podpac default settings</p></li>
<li><p>home directory settings (<code class="docutils literal notranslate"><span class="pre">~/.config/podpac/settings.json</span></code>)</p></li>
<li><p>current working directory settings (<code class="docutils literal notranslate"><span class="pre">./settings.json</span></code>)</p></li>
</ol>
<p>The attribute <code class="docutils literal notranslate"><span class="pre">settings.settings_path</span></code> shows the path of the last loaded settings file (e.g. the active settings file).</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="kn">from</span> <span class="nn">podpac</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="n">In</span> <span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="n">settings</span><span class="o">.</span><span class="n">settings_path</span>
<span class="n">Out</span><span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="s1">'C:</span><span class="se">\\</span><span class="s1">Users</span><span class="se">\\</span><span class="s1">user</span><span class="se">\\</span><span class="s1">.config</span><span class="se">\\</span><span class="s1">podpac'</span>
</pre></div>
</div>
<p>A <code class="docutils literal notranslate"><span class="pre">settings.json</span></code> file can be loaded from outside the search path using the <code class="docutils literal notranslate"><span class="pre">settings.load()</span></code> method:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="kn">from</span> <span class="nn">podpac</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="n">In</span> <span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="n">settings</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="s1">'custom/path/'</span><span class="p">,</span> <span class="n">filename</span><span class="o">=</span><span class="s1">'settings.json'</span><span class="p">)</span>
</pre></div>
</div>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="install.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="examples.html" class="btn btn-neutral float-right" title="Examples" 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>