-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdeploy-notes.html
More file actions
252 lines (226 loc) · 14.2 KB
/
deploy-notes.html
File metadata and controls
252 lines (226 loc) · 14.2 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
<!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>Deploy Notes for Developers — 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/deploy-notes.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" />
</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>
<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">Deploy Notes for Developers</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/deploy-notes.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="deploy-notes-for-developers">
<h1>Deploy Notes for Developers<a class="headerlink" href="#deploy-notes-for-developers" title="Permalink to this heading"></a></h1>
<blockquote>
<div><p>Note this it not included in built documentation</p>
</div></blockquote>
<section id="checklist">
<h2>Checklist<a class="headerlink" href="#checklist" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>[ ] Update version number</p></li>
<li><p>[ ] Update changelog</p></li>
<li><p>[ ] Update windows installation (see below)</p></li>
<li><p>[ ] Check all of the notebooks using the updated windows installation</p></li>
<li><p>[ ] Update the conda environment .yml file (do this by-hand with any new packages in setup.py)</p></li>
<li><p>[ ] Update the explicit conda environemnt file <code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">list</span> <span class="pre">--explicit</span> <span class="pre">></span> <span class="pre">filename.json</span></code></p></li>
<li><p>[ ] Update the <code class="docutils literal notranslate"><span class="pre">podpac_deps.zip</span></code> and <code class="docutils literal notranslate"><span class="pre">podpac_dist.zip</span></code> for the lambda function installs</p></li>
<li><p>[ ] Upload windows install folder to AWS</p></li>
<li><p>[ ] Make windows install folder public on AWS</p></li>
</ul>
</section>
<section id="uploading-to-pypi">
<h2>Uploading to pypi<a class="headerlink" href="#uploading-to-pypi" title="Permalink to this heading"></a></h2>
<p>Run this command to create the wheel and source code tarball</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ python setup.py sdist bdist_wheel
</pre></div>
</div>
<p>In case Twine is not installed, install it</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ pip install --upgrade twine
</pre></div>
</div>
<p>Now upload the package</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ python -m twine upload dist<span class="se">\*</span>
</pre></div>
</div>
<p>This will prompt you for your username and password. At the moment, only mpu and mls have privileges to upload to the PODPAC PYPI index.</p>
</section>
<section id="creating-the-windows-installation-podpac-conda-environment">
<h2>Creating the Windows Installation PODPAC Conda environment<a class="headerlink" href="#creating-the-windows-installation-podpac-conda-environment" title="Permalink to this heading"></a></h2>
<p>This section describes the process used to create the <a class="reference external" href="https://s3.amazonaws.com/podpac-s3/releases/PODPAC_latest_install_windows10.zip">PODPAC Window 10 Installation</a>.</p>
<p>These instructions only assume that you already have <a class="reference external" href="https://git-scm.com/">git</a> installed on your Windows 10 machine.</p>
<ul class="simple">
<li><p>Install miniconda to a <code class="docutils literal notranslate"><span class="pre"><root_folder></span></code>\miniconda on a Windows machine</p>
<ul>
<li><p>Install for “Just the current user”</p></li>
<li><p>Do not register Python to the operating system</p></li>
</ul>
</li>
<li><p>Open a Windows command prompt in the <code class="docutils literal notranslate"><span class="pre"><root_folder></span></code></p></li>
<li><p>Clone podpac and set up the conda environment</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/creare-com/podpac.git
$ git clone https://github.com/creare-com/podpac_examples.git
$ <span class="nb">cd</span> podpac
$ git checkout -b release/<version> tags/<version> <span class="c1"># as of writing, the <version> is 0.3.0</span>
$ <span class="nb">cd</span> ..
$ xcopy podpac<span class="se">\d</span>ist<span class="se">\l</span>ocal_Windows_install<span class="se">\*</span> . /E
$ bin<span class="se">\s</span>et_local_conda_path.bat
<span class="c1"># Verify path is set correctly</span>
$ where conda
<root_folder><span class="se">\m</span>iniconda<span class="se">\L</span>ibrary<span class="se">\b</span>in<span class="se">\c</span>onda.bat <span class="c1"># Should be the first entry</span>
<root_folder><span class="se">\m</span>iniconda<span class="se">\S</span>cripts<span class="se">\c</span>onda.exe <span class="c1"># Should be the second entry</span>
... <span class="c1"># May have additional entries</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Set up the podpac environment and install dependencies</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ conda create -n podpac <span class="nv">python</span><span class="o">=</span><span class="m">3</span>
$ bin<span class="se">\a</span>ctivate_podpac_conda_env.bat
<span class="c1"># Install core dependencies</span>
$ conda install matplotlib><span class="o">=</span><span class="m">2</span>.1 numpy><span class="o">=</span><span class="m">1</span>.14 scipy><span class="o">=</span><span class="m">1</span>.0 traitlets><span class="o">=</span><span class="m">4</span>.3 xarray><span class="o">=</span><span class="m">0</span>.10 ipython psutil requests><span class="o">=</span><span class="m">2</span>.18 owslib
$ conda install pyproj><span class="o">=</span><span class="m">2</span>.2 rasterio><span class="o">=</span><span class="m">1</span>.0 -c conda-forge
$ pip install pint><span class="o">=</span><span class="m">0</span>.8 lazy-import><span class="o">=</span><span class="m">0</span>.2.2
<span class="c1"># Install dependencies for handling various file datatype</span>
$ <span class="c1"># conda install rasterio>=1.0 # Installed above alongside pyproj</span>
$ conda install beautifulsoup4><span class="o">=</span><span class="m">4</span>.6 h5py><span class="o">=</span><span class="m">2</span>.9 lxml><span class="o">=</span><span class="m">4</span>.2 zarr><span class="o">=</span><span class="m">2</span>.3 intake><span class="o">=</span><span class="m">0</span>.5
$ pip install pydap><span class="o">=</span><span class="m">3</span>.2
<span class="c1"># Install dependencies for AWS</span>
$ conda install boto3><span class="o">=</span><span class="m">1</span>.4 s3fs><span class="o">=</span><span class="m">0</span>.2
$ pip install awscli><span class="o">=</span><span class="m">1</span>.11
<span class="c1"># Install dependencies for algorithm nodes</span>
$ conda install numexpr><span class="o">=</span><span class="m">2</span>.6
<span class="c1"># Install dependencies for JupyterLab and Jupyter Notebooks</span>
$ conda install jupyterlab ipywidgets nodejs
$ conda install ipympl ipyleaflet -c conda-forge
<span class="c1"># Set up jupyter lab extensions</span>
$ jupyter labextension install @jupyter-widgets/jupyterlab-manager
$ jupyter labextension install jupyter-leaflet
$ jupyter labextension install jupyter-matplotlib
$ jupyter nbextension <span class="nb">enable</span> --py widgetsnbextension
$ jupyter lab build
</pre></div>
</div>
<p>~~$ python -m ipykernel install –user~~</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># clean conda environment</span>
$ conda clean -a -y
<span class="c1"># Also delete miniconda/pkgs/.trash for a smaller installation</span>
</pre></div>
</div>
<ul class="simple">
<li><p>To run a <code class="docutils literal notranslate"><span class="pre">JupyterLab</span></code> sessions in the <code class="docutils literal notranslate"><span class="pre"><root_folder>\podpac_examples\notebooks</span></code> directory, double-click on the <code class="docutils literal notranslate"><span class="pre">run_podpac_jupyterlab.bat</span></code>. This will launch a browser window in the folder where PODPAC keeps its example notebooks.</p></li>
<li><p>To run an IPython console: Open up a Windows command prompt in <code class="docutils literal notranslate"><span class="pre"><root_folder></span></code></p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ run_ipython.bat
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer>
<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>