-
Notifications
You must be signed in to change notification settings - Fork 1
/
libraries.html
258 lines (244 loc) · 17.7 KB
/
libraries.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
246
247
248
249
250
251
252
253
254
255
256
257
258
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Libraries — scikit-tda 0.0.4 documentation</title>
<link rel="stylesheet" href="_static/better.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Tutorials" href="tutorials/index.html" />
<link rel="prev" title="Theory" href="theory.html" />
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
</head><body>
<header id="pageheader">
<h1>
<a href="index.html ">
scikit-tda 0.0.4 documentation
</a>
<a id="headermeta" href="https://scikit-tda.org">
a scikit-tda project
</a>
</h1>
</header>
<div class="related top">
<nav id="rellinks">
<ul>
<li>
←
<a href="theory.html" title="Previous document">Theory</a>
</li>
<li>
<a href="tutorials/index.html" title="Next document">Tutorials</a>
→
</li>
</ul>
</nav>
<nav id="breadcrumbs">
<ul>
<li><a href="index.html">scikit-tda</a></li>
</ul>
</nav>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="libraries">
<span id="id1"></span><h1>Libraries<a class="headerlink" href="#libraries" title="Permalink to this headline">¶</a></h1>
<p>Scikit-TDA provides a complete suite of TDA tools designed for academic or industry uses.</p>
<p>To install the entire suite</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">pip</span> <span class="n">install</span> <span class="n">scikit</span><span class="o">-</span><span class="n">tda</span>
</pre></div>
</div>
<p>Below, you’ll find information on each individual package, along with resources to explore more. Each package is well tested, well documented, easy to install, and open for contributions. If you find any bugs in the code or documentation, please let us know on <a class="reference external" href="https://github.com/scikit-tda">github</a></p>
<hr><a class="reference external image-reference" href="https://ripser.scikit-tda.org"><img alt="logo for cec" class="align-right" src="_images/ripser.png" style="height: 130px;" /></a>
<div class="section" id="ripser-py">
<h2>Ripser.py<a class="headerlink" href="#ripser-py" title="Permalink to this headline">¶</a></h2>
<a class="reference external image-reference" href="https://badge.fury.io/py/ripser"><img alt="https://badge.fury.io/py/ripser.svg" src="https://badge.fury.io/py/ripser.svg" /></a>
<a class="reference external image-reference" href="https://pypi.python.org/pypi/ripser/"><img alt="https://pypip.in/download/ripser/badge.svg" src="https://pypip.in/download/ripser/badge.svg" /></a>
<a class="reference external image-reference" href="https://travis-ci.org/scikit-tda/ripser.py"><img alt="https://travis-ci.org/scikit-tda/ripser.py.svg?branch=master" src="https://travis-ci.org/scikit-tda/ripser.py.svg?branch=master" /></a>
<a class="reference external image-reference" href="https://codecov.io/gh/scikit-tda/ripser.py"><img alt="https://codecov.io/gh/scikit-tda/ripser.py/branch/master/graph/badge.svg" src="https://codecov.io/gh/scikit-tda/ripser.py/branch/master/graph/badge.svg" /></a>
<a class="reference external image-reference" href="https://opensource.org/licenses/MIT)"><img alt="https://img.shields.io/badge/License-MIT-yellow.svg" src="https://img.shields.io/badge/License-MIT-yellow.svg" /></a>
<div class="docutils container">
<p>Ripser.py is a lean persistent homology package for Python. Building on the blazing fast C++ Ripser package as the core computational engine, Ripser.py provides an intuitive interface for</p>
<ul class="simple">
<li>computing persistence cohomology of sparse and dense data sets,</li>
<li>visualizing persistence diagrams,</li>
<li>computing lowerstar filtrations on images, and</li>
<li>computing representative cochains.</li>
</ul>
<p>Installation is as easy as</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">pip</span> <span class="n">install</span> <span class="n">ripser</span>
</pre></div>
</div>
<p>Check out complete documentation for Ripser.py at <a class="reference external" href="https://ripser.scikit-tda.org">ripser.scikit-tda.org</a> and the source code at <a class="reference external" href="https://github.com/scikit-tda/ripser.py">github.com/scikit-tda/ripser.py</a></p>
</div>
<hr><a class="reference external image-reference" href="https://kepler-mapper.scikit-tda.org"><img alt="logo for cec" class="align-right" src="_images/kepler-mapper.png" style="height: 130px;" /></a>
</div>
<div class="section" id="kepler-mapper">
<h2>Kepler Mapper<a class="headerlink" href="#kepler-mapper" title="Permalink to this headline">¶</a></h2>
<a class="reference external image-reference" href="https://badge.fury.io/py/kmapper"><img alt="https://badge.fury.io/py/kmapper.svg" src="https://badge.fury.io/py/kmapper.svg" /></a>
<a class="reference external image-reference" href="https://pypi.python.org/pypi/kmapper/"><img alt="https://pypip.in/download/kmapper/badge.svg" src="https://pypip.in/download/kmapper/badge.svg" /></a>
<a class="reference external image-reference" href="https://travis-ci.org/scikit-tda/kepler-mapper"><img alt="https://travis-ci.org/scikit-tda/kepler-mapper.svg?branch=master" src="https://travis-ci.org/scikit-tda/kepler-mapper.svg?branch=master" /></a>
<a class="reference external image-reference" href="https://codecov.io/gh/scikit-tda/kepler-mapper"><img alt="https://codecov.io/gh/scikit-tda/kepler-mapper/branch/master/graph/badge.svg" src="https://codecov.io/gh/scikit-tda/kepler-mapper/branch/master/graph/badge.svg" /></a>
<a class="reference external image-reference" href="https://opensource.org/licenses/MIT)"><img alt="https://img.shields.io/badge/License-MIT-yellow.svg" src="https://img.shields.io/badge/License-MIT-yellow.svg" /></a>
<div class="docutils container">
<p>Kepler Mapper is a library implementing the Mapper algorithm in Python. Mapper can be used for visualization of the topological structures in a high-dimensional data point cloud data. Kepler Mapper leverages Scikit-Learn API compatible cluster and scaling algorithms to streamline the construction of the algorithm. The library also provides multiple visualization tools built on D3.js or Plotly.</p>
<p>Installation is as easy as</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">pip</span> <span class="n">install</span> <span class="n">kmapper</span>
</pre></div>
</div>
<p>Check out complete documentation for Kepler Mapper at <a class="reference external" href="https://kepler-mapper.scikit-tda.org">kepler-mapper.scikit-tda.org</a> and the source code at <a class="reference external" href="https://github.com/scikit-tda/kepler-mapper">github.com/scikit-tda/kepler-mapper</a></p>
</div>
<hr><a class="reference external image-reference" href="https://persim.scikit-tda.org"><img alt="logo for cec" class="align-right" src="_images/persim.png" style="height: 130px;" /></a>
</div>
<div class="section" id="persim">
<h2>Persim<a class="headerlink" href="#persim" title="Permalink to this headline">¶</a></h2>
<a class="reference external image-reference" href="https://badge.fury.io/py/persim"><img alt="https://badge.fury.io/py/persim.svg" src="https://badge.fury.io/py/persim.svg" /></a>
<a class="reference external image-reference" href="https://pypi.python.org/pypi/persim/"><img alt="https://pypip.in/download/persim/badge.svg" src="https://pypip.in/download/persim/badge.svg" /></a>
<a class="reference external image-reference" href="https://travis-ci.org/scikit-tda/persim"><img alt="https://travis-ci.org/scikit-tda/persim.svg?branch=master" src="https://travis-ci.org/scikit-tda/persim.svg?branch=master" /></a>
<a class="reference external image-reference" href="https://codecov.io/gh/scikit-tda/persim"><img alt="https://codecov.io/gh/scikit-tda/persim/branch/master/graph/badge.svg" src="https://codecov.io/gh/scikit-tda/persim/branch/master/graph/badge.svg" /></a>
<a class="reference external image-reference" href="https://opensource.org/licenses/MIT)"><img alt="https://img.shields.io/badge/License-MIT-yellow.svg" src="https://img.shields.io/badge/License-MIT-yellow.svg" /></a>
<div class="docutils container">
<p>Once diagrams are constructed, the Persim package comes into play.
This package houses many methods for comparison and analysis of persistence diagrams. It currently houses implementations of</p>
<ul class="simple">
<li>Persistence Images</li>
<li>Diagram distances (Bottleneck distance, Sliced Wasserstein Kernel, Heat Kernel)</li>
<li>Diagram visualization</li>
</ul>
<p>Installation is as easy as</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">pip</span> <span class="n">install</span> <span class="n">persim</span>
</pre></div>
</div>
<p>Check out complete documentation for Persim at <a class="reference external" href="https://persim.scikit-tda.org">persim.scikit-tda.org</a> and the source code at <a class="reference external" href="https://github.com/scikit-tda/persim">github.com/scikit-tda/persim</a></p>
</div>
<hr><a class="reference external image-reference" href="https://cechmate.scikit-tda.org"><img alt="logo for cec" class="align-right" src="_images/cechmate.png" style="height: 130px;" /></a>
</div>
<div class="section" id="cechmate">
<h2>CechMate<a class="headerlink" href="#cechmate" title="Permalink to this headline">¶</a></h2>
<a class="reference external image-reference" href="https://badge.fury.io/py/cechmate"><img alt="https://badge.fury.io/py/cechmate.svg" src="https://badge.fury.io/py/cechmate.svg" /></a>
<a class="reference external image-reference" href="https://pypi.python.org/pypi/cechmate/"><img alt="https://pypip.in/download/cechmate/badge.svg" src="https://pypip.in/download/cechmate/badge.svg" /></a>
<a class="reference external image-reference" href="https://travis-ci.org/scikit-tda/cechmate"><img alt="https://travis-ci.org/scikit-tda/cechmate.svg?branch=master" src="https://travis-ci.org/scikit-tda/cechmate.svg?branch=master" /></a>
<a class="reference external image-reference" href="https://codecov.io/gh/scikit-tda/cechmate"><img alt="https://codecov.io/gh/scikit-tda/cechmate/branch/master/graph/badge.svg" src="https://codecov.io/gh/scikit-tda/cechmate/branch/master/graph/badge.svg" /></a>
<a class="reference external image-reference" href="https://opensource.org/licenses/MIT)"><img alt="https://img.shields.io/badge/License-MIT-yellow.svg" src="https://img.shields.io/badge/License-MIT-yellow.svg" /></a>
<div class="docutils container">
<p>This library provides easy to use constructors for custom filtrations that are suitable for use with Phat. Phat currently provides a clean interface for persistence reduction algorithms for boundary matrices. This tool helps bridge the gap between data and boundary matrices. Currently, we support construction of</p>
<ul class="simple">
<li>Alpha filtrations,</li>
<li>Rips filtrations, and</li>
<li>Cech filtrations, and</li>
<li>provide an easy interface for Phat.</li>
</ul>
<p>Installation is as easy as</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">pip</span> <span class="n">install</span> <span class="n">cechmate</span>
</pre></div>
</div>
<p>Check out complete documentation for CechMate at <a class="reference external" href="https://cechmate.scikit-tda.org">cechmate.scikit-tda.org</a> and the source code at <a class="reference external" href="https://github.com/scikit-tda/cechmate">github.com/scikit-tda/cechmate</a></p>
</div>
<hr><a class="reference external image-reference" href="https://tadasets.scikit-tda.org"><img alt="logo for cec" class="align-right" src="_images/tadasets.png" style="height: 130px;" /></a>
</div>
<div class="section" id="tadasets">
<h2>TaDAsets<a class="headerlink" href="#tadasets" title="Permalink to this headline">¶</a></h2>
<a class="reference external image-reference" href="https://badge.fury.io/py/tadasets"><img alt="https://badge.fury.io/py/tadasets.svg" src="https://badge.fury.io/py/tadasets.svg" /></a>
<a class="reference external image-reference" href="https://pypi.python.org/pypi/tadasets/"><img alt="https://pypip.in/download/tadasets/badge.svg" src="https://pypip.in/download/tadasets/badge.svg" /></a>
<a class="reference external image-reference" href="https://travis-ci.org/scikit-tda/tadasets"><img alt="https://travis-ci.org/scikit-tda/tadasets.svg?branch=master" src="https://travis-ci.org/scikit-tda/tadasets.svg?branch=master" /></a>
<a class="reference external image-reference" href="https://codecov.io/gh/scikit-tda/tadasets"><img alt="https://codecov.io/gh/scikit-tda/tadasets/branch/master/graph/badge.svg" src="https://codecov.io/gh/scikit-tda/tadasets/branch/master/graph/badge.svg" /></a>
<a class="reference external image-reference" href="https://opensource.org/licenses/MIT)"><img alt="https://img.shields.io/badge/License-MIT-yellow.svg" src="https://img.shields.io/badge/License-MIT-yellow.svg" /></a>
<div class="docutils container">
<p>This package provides some nice utilities for creating and loading data sets that are useful for Topological Data Analysis. Currently, we provide various synthetic data sets with particular topological features and various levels of noise and dimension. Currently includes</p>
<ul class="simple">
<li>n-spheres,</li>
<li>torus,</li>
<li>swiss rolls, and</li>
<li>figure 8s.</li>
</ul>
<p>Installation is as easy as</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">pip</span> <span class="n">install</span> <span class="n">tadasets</span>
</pre></div>
</div>
<p>Check out complete documentation for TaDAsets at <a class="reference external" href="https://tadasets.scikit-tda.org">tadasets.scikit-tda.org</a> and the source code at <a class="reference external" href="https://github.com/scikit-tda/tadasets">github.com/scikit-tda/tadasets</a></p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a></p>
<form class="search" action="search.html" method="get">
<input type="text" name="q"
placeholder="type to search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<script type="text/javascript">$('#searchbox').show(0);</script>
<a href=https://github.com/scikit-tda>
<p class="caption"><span class="caption-text">
<img src="_static/gh_logo.png"
height="18px"
width="18px" alt="Github icon">
scikit-tda
</span></p>
</a>
<p class="caption"><span class="caption-text">User Guide</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="theory.html">Theory</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Libraries</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#ripser-py">Ripser.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="#kepler-mapper">Kepler Mapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="#persim">Persim</a></li>
<li class="toctree-l2"><a class="reference internal" href="#cechmate">CechMate</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tadasets">TaDAsets</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">Tutorials</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related bottom">
<nav id="rellinks">
<ul>
<li>
←
<a href="theory.html" title="Previous document">Theory</a>
</li>
<li>
<a href="tutorials/index.html" title="Next document">Tutorials</a>
→
</li>
</ul>
</nav>
<nav id="breadcrumbs">
<ul>
<li><a href="index.html">scikit-tda</a></li>
</ul>
</nav>
</div>
<footer id="pagefooter">© 2019, Nathaniel Saul.
Created using <a href="http://sphinx-doc.org/">Sphinx</a>
1.8.4.
</footer>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-124965309-1', '');
ga('send', 'pageview');
</script>
</body>
</html>