-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
168 lines (154 loc) · 9.66 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
<!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>Install — 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="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="# ">
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="Next document">Theory</a>
→
</li>
</ul>
</nav>
<nav id="breadcrumbs">
<ul>
<li><a href="#">scikit-tda</a></li>
</ul>
</nav>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<p><a class="reference external" href="https://zenodo.org/badge/latestdoi/129452930"><img alt="DOI" src="https://zenodo.org/badge/129452930.svg" /></a> <a class="reference external" href="https://badge.fury.io/py/scikit-tda"><img alt="Pypi" src="https://badge.fury.io/py/scikit-tda.svg" /></a> <a class="reference external" href="https://pypi.python.org/scikit-tda/sktda/"><img alt="Downloads" src="https://pypip.in/download/scikit-tda/badge.svg" /></a></p>
<p>Scikit-TDA is a home for Topological Data Analysis Python libraries intended for non-topologists. This project aims to provide a curated library of TDA Python tools that are widely usable and easily approachable.</p>
<p>The structure of these libraries is inspired by the <a class="reference external" href="https://tidyverse.org">Tidyverse</a> in that each package can stand alone and can be installed individually but each adheres to the same design principles. Further, the most benefit comes from using all of them together. You’ll notice that in many of the examples and notebooks, multiple libraries are used together.</p>
<p>This project is entirely a work in progress and still in an early phase.
We hope to assemble an ecosystem of TDA libraries that is approachable to people outside the field of Algebraic Topology, complete with documentation, notebooks, and examples to get you up to speed.</p>
<p>If you would like to contribute, please reach out to us on <a class="reference external" href="https://github.com/scikit-tda">github</a>, <a class="reference external" href="https://twitter.com/scikit_tda">twitter</a> or on <a class="reference external" href="https://scikit-tda.slack.com">slack</a>.</p>
<div class="section" id="install">
<h1>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h1>
<p>Installation of all libraries can be done directly from Pypi in one command.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></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>
</div>
<div class="section" id="contact">
<h1>Contact<a class="headerlink" href="#contact" title="Permalink to this headline">¶</a></h1>
<p>If you would like to contribute and have ideas for how to do so, please reach out!
You can join us at <cite>scikit-tda.slack.com</cite> or follow us on twitter <a class="reference external" href="https://twitter.com/scikit_tda">@scikit_tda</a>.
If you have any issues or confusion while using the library, please let us know with a <a class="reference external" href="https://github.com/scikit-tda">github</a> issue. We will try to respond quickly.</p>
</div>
<div class="section" id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
<p>Contributions are more than welcome! There are lots of opportunities for potential projects, so please get in touch if you would like to help out. Everything from code to notebooks to examples and documentation are all equally valuable so please don’t feel you can’t contribute. To contribute please fork the project make your changes and submit a pull request. We will do our best to work through any issues with you and get your code merged into the main branch.</p>
</div>
<div class="section" id="citation">
<h1>Citation<a class="headerlink" href="#citation" title="Permalink to this headline">¶</a></h1>
<p>For the time being, if you would like to cite Scikit-TDA, please use the following citation/bibtex:</p>
<blockquote>
<div>Saul, Nathaniel and Tralie, Chris. (2019). Scikit-TDA: Topological Data Analysis for Python. Zenodo. <a class="reference external" href="http://doi.org/10.5281/zenodo.2533369">http://doi.org/10.5281/zenodo.2533369</a></div></blockquote>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@misc</span><span class="p">{</span><span class="n">scikittda2019</span><span class="p">,</span>
<span class="n">author</span> <span class="o">=</span> <span class="p">{</span><span class="n">Nathaniel</span> <span class="n">Saul</span> <span class="ow">and</span> <span class="n">Chris</span> <span class="n">Tralie</span><span class="p">},</span>
<span class="n">title</span> <span class="o">=</span> <span class="p">{</span><span class="n">Scikit</span><span class="o">-</span><span class="n">TDA</span><span class="p">:</span> <span class="n">Topological</span> <span class="n">Data</span> <span class="n">Analysis</span> <span class="k">for</span> <span class="n">Python</span><span class="p">},</span>
<span class="n">year</span> <span class="o">=</span> <span class="mi">2019</span><span class="p">,</span>
<span class="n">doi</span> <span class="o">=</span> <span class="p">{</span><span class="mf">10.5281</span><span class="o">/</span><span class="n">zenodo</span><span class="o">.</span><span class="mi">2533369</span><span class="p">},</span>
<span class="n">url</span> <span class="o">=</span> <span class="p">{</span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">doi</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="mf">10.5281</span><span class="o">/</span><span class="n">zenodo</span><span class="o">.</span><span class="mi">2533369</span><span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="license">
<h1>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h1>
<p>This package is licensed with the MIT license.</p>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="#">
<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>
<li class="toctree-l1"><a class="reference internal" href="theory.html">Theory</a></li>
<li class="toctree-l1"><a class="reference internal" href="libraries.html">Libraries</a></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="Next document">Theory</a>
→
</li>
</ul>
</nav>
<nav id="breadcrumbs">
<ul>
<li><a href="#">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>