-
Notifications
You must be signed in to change notification settings - Fork 78
/
index.html
245 lines (218 loc) · 13.6 KB
/
index.html
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
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>libpysal: Python Spatial Analysis Library Core — libpysal v4.10 Manual</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=9afac83c" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="_static/pysal-styles.css?v=38b0ce36" />
<script src="_static/documentation_options.js?v=e70c6326"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<link rel="icon" href="_static/pysal_favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.12.4.min.js"></script>
<script type="text/javascript" src="_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="_static/bootstrap-3.4.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="#">
libpysal</a>
<span class="navbar-text navbar-version pull-left"><b>4.10</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li><a href="installation.html">Installation</a></li>
<li><a href="tutorial.html">Tutorial</a></li>
<li><a href="api.html">API</a></li>
<li><a href="references.html">References</a></li>
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="#">Site <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-released-version">Installing released version</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-development-version">Installing development version</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#spatial-weights">Spatial Weights</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#example-datasets">Example Datasets</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#spatial-weights">Spatial Weights</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#cg-computational-geometry">cg: Computational Geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#io">io</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#examples">examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#experimental">Experimental</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#graph">graph</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
</ul>
</ul>
</li>
<li class="dropdown">
<a role="button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page <b class="caret"></b></a>
<ul class="dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">libpysal: Python Spatial Analysis Library Core</a><ul>
<li><a class="reference internal" href="#introduction">Introduction</a></li>
<li><a class="reference internal" href="#development">Development</a></li>
<li><a class="reference internal" href="#getting-involved">Getting Involved</a></li>
<li><a class="reference internal" href="#bug-reports">Bug reports</a></li>
<li><a class="reference internal" href="#citing-libpysal">Citing libpysal</a></li>
<li><a class="reference internal" href="#license-information">License information</a></li>
</ul>
</li>
<li><a class="reference internal" href="#libpysal">libpysal</a></li>
</ul>
</ul>
</li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<section id="libpysal-python-spatial-analysis-library-core">
<h1>libpysal: Python Spatial Analysis Library Core<a class="headerlink" href="#libpysal-python-spatial-analysis-library-core" title="Link to this heading">¶</a></h1>
<a class="reference external image-reference" href="https://github.com/pysal/libpysal/actions?query=workflow%3A.github%2Fworkflows%2Funittests.yml"><img alt="https://github.com/pysal/libpysal/workflows/.github/workflows/unittests.yml/badge.svg" src="https://github.com/pysal/libpysal/workflows/.github/workflows/unittests.yml/badge.svg" /></a>
<a class="reference external image-reference" href="https://discord.gg/BxFTEPFFZn"><img alt="https://img.shields.io/badge/Discord-join%20chat-7289da?style=flat&logo=discord&logoColor=cccccc" src="https://img.shields.io/badge/Discord-join%20chat-7289da?style=flat&logo=discord&logoColor=cccccc" /></a>
<a class="reference external image-reference" href="https://badge.fury.io/py/libpysal"><img alt="https://badge.fury.io/py/libpysal.svg" src="https://badge.fury.io/py/libpysal.svg" /></a>
<div class="container-fluid">
<div class="row equal-height">
<div class="col-sm-1 col-xs-hidden">
</div>
<div class="col-sm-10 col-xs-12">
<a href="http://nbviewer.jupyter.org/github/pysal/libpysal/blob/main/notebooks/weights.ipynb" class="thumbnail">
<img src="_static/images/npweights.png" class="img-responsive center-block">
<div class="caption text-center">
<h6>Weights for nonplanar enforced geometries</h6>
</div>
</a>
</div>
<div class="col-sm-1 col-xs-hidden">
</div>
</div>
</div><section id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h2>
<p><strong>libpysal</strong> offers four modules that form the building blocks in many upstream packages in the <a class="reference external" href="https://pysal.org">PySAL family</a>:</p>
<ul class="simple">
<li><p>Spatial Weights: libpysal.weights</p></li>
<li><p>Input-and output: libpysal.io</p></li>
<li><p>Computational geometry: libpysal.cg</p></li>
<li><p>Built-in example datasets libpysal.examples</p></li>
</ul>
<p>Examples demonstrating some of <strong>libpysal</strong> functionality are available in the <a class="reference external" href="tutorial.html">tutorial</a>.</p>
<p>Details are available in the <a class="reference external" href="api.html">libpysal api</a>.</p>
<p>For background information see <span id="id1">[<a class="reference internal" href="references.html#id3" title="Sergio J. Rey and Luc Anselin. PySAL: A Python Library of Spatial Analytical Methods. The Review of Regional Studies, 37(1):5-27, 2007.">RA07</a>]</span>.</p>
</section>
<section id="development">
<h2>Development<a class="headerlink" href="#development" title="Link to this heading">¶</a></h2>
<p>libpysal development is hosted on <a class="reference external" href="https://github.com/pysal/libpysal">github</a>.</p>
<p>Discussions of development occurs on the
<a class="reference external" href="http://groups.google.com/group/pysal-dev">developer list</a>
as well as <a class="reference external" href="https://discord.gg/BxFTEPFFZn">discord</a>.</p>
</section>
<section id="getting-involved">
<h2>Getting Involved<a class="headerlink" href="#getting-involved" title="Link to this heading">¶</a></h2>
<p>If you are interested in contributing to PySAL please see our
<a class="reference external" href="https://github.com/pysal/pysal/wiki">development guidelines</a>.</p>
</section>
<section id="bug-reports">
<h2>Bug reports<a class="headerlink" href="#bug-reports" title="Link to this heading">¶</a></h2>
<p>To search for or report bugs, please see libpysal’s <a class="reference external" href="http://github.com/pysal/libpysal/issues">issues</a>.</p>
</section>
<section id="citing-libpysal">
<h2>Citing libpysal<a class="headerlink" href="#citing-libpysal" title="Link to this heading">¶</a></h2>
<p>If you use PySAL in a scientific publication, we would appreciate citations to the following paper:</p>
<blockquote>
<div><p><a class="reference external" href="http://journal.srsa.org/ojs/index.php/RRS/article/view/134/85">PySAL: A Python Library of Spatial Analytical Methods</a>, <em>Rey, S.J. and L. Anselin</em>, Review of Regional Studies 37, 5-27 2007.</p>
<p>Bibtex entry:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@Article</span><span class="p">{</span><span class="n">pysal2007</span><span class="p">,</span>
<span class="n">author</span><span class="o">=</span><span class="p">{</span><span class="n">Rey</span><span class="p">,</span> <span class="n">Sergio</span> <span class="n">J</span><span class="o">.</span> <span class="ow">and</span> <span class="n">Anselin</span><span class="p">,</span> <span class="n">Luc</span><span class="p">},</span>
<span class="n">title</span><span class="o">=</span><span class="p">{{</span><span class="n">PySAL</span><span class="p">:</span> <span class="n">A</span> <span class="n">Python</span> <span class="n">Library</span> <span class="n">of</span> <span class="n">Spatial</span> <span class="n">Analytical</span> <span class="n">Methods</span><span class="p">}},</span>
<span class="n">journal</span><span class="o">=</span><span class="p">{</span><span class="n">The</span> <span class="n">Review</span> <span class="n">of</span> <span class="n">Regional</span> <span class="n">Studies</span><span class="p">},</span>
<span class="n">year</span><span class="o">=</span><span class="mi">2007</span><span class="p">,</span>
<span class="n">volume</span><span class="o">=</span><span class="p">{</span><span class="mi">37</span><span class="p">},</span>
<span class="n">number</span><span class="o">=</span><span class="p">{</span><span class="mi">1</span><span class="p">},</span>
<span class="n">pages</span><span class="o">=</span><span class="p">{</span><span class="mi">5</span><span class="o">-</span><span class="mi">27</span><span class="p">},</span>
<span class="n">keywords</span><span class="o">=</span><span class="p">{</span><span class="n">Open</span> <span class="n">Source</span><span class="p">;</span> <span class="n">Software</span><span class="p">;</span> <span class="n">Spatial</span><span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</section>
<section id="license-information">
<h2>License information<a class="headerlink" href="#license-information" title="Link to this heading">¶</a></h2>
<p>See the file “LICENSE.txt” for information on the history of this
software, terms & conditions for usage, and a DISCLAIMER OF ALL
WARRANTIES.</p>
</section>
</section>
<section id="libpysal">
<h1>libpysal<a class="headerlink" href="#libpysal" title="Link to this heading">¶</a></h1>
<p>Core components of the Python Spatial Analysis Library (<a class="reference external" href="https://github.com/pysal/pysal">PySAL</a>)</p>
<div class="toctree-wrapper compound">
</div>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
<br/>
<div id="sourcelink">
<a href="_sources/index.rst.txt"
rel="nofollow">Source</a>
</div>
</p>
<p>
© Copyright 2018-, pysal developers.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.<br/>
</p>
</div>
</footer>
</body>
</html>