-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdependencies.html
More file actions
258 lines (239 loc) · 14.2 KB
/
dependencies.html
File metadata and controls
258 lines (239 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
253
254
255
256
257
258
<!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>Dependencies — 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/dependencies.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="Nodes" href="nodes.html" />
<link rel="prev" title="Design" href="design.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 current"><a class="current reference internal" href="#">Dependencies</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#os-specific-requirements">OS Specific Requirements</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#windows">Windows</a></li>
<li class="toctree-l3"><a class="reference internal" href="#mac">Mac</a></li>
<li class="toctree-l3"><a class="reference internal" href="#linux">Linux</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#core-dependencies">Core Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="#optional-dependencies">Optional Dependencies</a></li>
</ul>
</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">Dependencies</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/dependencies.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="dependencies">
<h1>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this heading"></a></h1>
<p>This document provides an overview of the dependencies leveraged by PODPAC.</p>
<section id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://www.python.org/">Python</a> (3.6 or later) — <a class="reference external" href="https://www.anaconda.com/distribution/#download-section">Anaconda Python Distribution</a> recommended</p></li>
</ul>
</section>
<section id="os-specific-requirements">
<h2>OS Specific Requirements<a class="headerlink" href="#os-specific-requirements" title="Permalink to this heading"></a></h2>
<p>If using <code class="docutils literal notranslate"><span class="pre">pip</span></code> to install, the following OS specific dependencies are required to successfully install and run PODPAC.</p>
<section id="windows">
<h3>Windows<a class="headerlink" href="#windows" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>No external dependencies necessary, though using Anaconda is recommended.</p>
</div></blockquote>
</section>
<section id="mac">
<h3>Mac<a class="headerlink" href="#mac" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>No external dependencies necessary, though using Anaconda is recommended.</p>
</div></blockquote>
</section>
<section id="linux">
<h3>Linux<a class="headerlink" href="#linux" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">build-essential</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">python-dev</span></code></p></li>
</ul>
<p>For debian installations:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo apt-get update
$ sudo apt-get install build-essential python-dev
</pre></div>
</div>
</section>
</section>
<section id="core-dependencies">
<h2>Core Dependencies<a class="headerlink" href="#core-dependencies" title="Permalink to this heading"></a></h2>
<blockquote>
<div><p>See <a class="reference external" href="https://github.com/creare-com/podpac/blob/master/setup.py">setup.py</a> for the latest dependencies listing.</p>
</div></blockquote>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>"matplotlib>=2.1",
"numpy>=1.14",
"pint>=0.8",
"scipy>=1.0",
"traitlets>=4.3",
"xarray>=0.10",
"requests>=2.18",
"pyproj>=2.4",
"lazy-import>=0.2.2",
"psutil",
</pre></div>
</div>
<ul class="simple">
<li><p><a class="reference external" href="http://www.numpy.org/">numpy</a>, <a class="reference external" href="https://www.scipy.org/">scipy</a>, <a class="reference external" href="http://xarray.pydata.org/en/stable/">xarray</a>: array handling</p></li>
<li><p><a class="reference external" href="https://github.com/ipython/traitlets">traitlets</a>: input and type handling</p></li>
<li><p><a class="reference external" href="https://pint.readthedocs.io/en/latest/">pint</a>: unit handling</p></li>
<li><p><a class="reference external" href="http://docs.python-requests.org/en/master/">requests</a>: HTTP requests</p></li>
<li><p><a class="reference external" href="https://matplotlib.org/">matplotlib</a>: plotting</p></li>
<li><p><a class="reference external" href="http://pyproj4.github.io/pyproj/stable/">pyproj</a>: coordinate reference system handling</p></li>
<li><p><a class="reference external" href="https://psutil.readthedocs.io/en/latest/">psutil</a>: cache management</p></li>
</ul>
</section>
<section id="optional-dependencies">
<h2>Optional Dependencies<a class="headerlink" href="#optional-dependencies" title="Permalink to this heading"></a></h2>
<blockquote>
<div><p>Optional dependencies can be <a class="reference internal" href="#install.html#install-with-pip"><span class="xref myst">installed using <code class="docutils literal notranslate"><span class="pre">pip</span></code></span></a></p>
</div></blockquote>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">datatype</span></code>: Data Handling</p>
<ul>
<li><p><a class="reference external" href="https://www.h5py.org/">h5py</a>: interface to the HDF5 data format</p></li>
<li><p><a class="reference external" href="http://www.pydap.org/en/latest/">pydap</a>: python support for Data Access Protocol (OPeNDAP)</p></li>
<li><p><a class="reference external" href="https://github.com/mapbox/rasterio">rasterio</a>: read GeoTiff and other raster datasets</p></li>
<li><p><a class="reference external" href="https://github.com/lxml/lxml">lxml</a>: read xml and html files</p></li>
<li><p><a class="reference external" href="https://www.crummy.com/software/BeautifulSoup/">beautifulsoup4</a>: text parser and screen scraper</p></li>
<li><p><a class="reference external" href="https://zarr.readthedocs.io/en/stable/">zarr</a>: cloud optimized storage format</p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">aws</span></code>: AWS integration</p>
<ul>
<li><p><a class="reference external" href="https://github.com/aws/aws-cli">awscli</a>: unified command line interface to Amazon Web Services</p></li>
<li><p><a class="reference external" href="https://boto3.amazonaws.com/v1/documentation/api/latest/index.html">boto3</a>: Amazon Web Services (AWS) SDK for Python</p></li>
<li><p><a class="reference external" href="https://pypi.org/project/s3fs/">s3fs</a>: Convenient Filesystem interface over S3.</p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">algorithm</span></code>: Algorithm development</p>
<ul>
<li><p><a class="reference external" href="https://github.com/pydata/numexpr">numexpr</a>: fast numerical expression evaluator for NumPy</p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">notebook</span></code>: Jupyter Notebooks</p>
<ul>
<li><p><a class="reference external" href="https://github.com/jupyterlab/jupyterlab">jupyterlab</a>: extensible environment for interactive and reproducible computing</p></li>
<li><p><a class="reference external" href="https://github.com/jupyter-widgets/ipyleaflet">ipyleaflet</a>: <a class="reference external" href="https://leafletjs.com/">LeafletJS</a> interface for jupyter notebooks</p></li>
<li><p><a class="reference external" href="https://ipywidgets.readthedocs.io/en/stable/">ipywidgets</a>: interactive widgets for Jupyter notebooks</p></li>
<li><p><a class="reference external" href="https://pypi.org/project/ipympl/">ipympl</a>: matplotlib jupyter notebook extension</p></li>
<li><p><a class="reference external" href="https://github.com/markfinger/python-nodejs">nodejs</a>: Python bindings and utils for <a class="reference external" href="https://nodejs.org/en/">NodeJS</a></p></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="design.html" class="btn btn-neutral float-left" title="Design" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="nodes.html" class="btn btn-neutral float-right" title="Nodes" 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>