1<!DOCTYPE html> 2 3<html lang="en" data-content_root="./"> 4 <head> 5 <meta charset="utf-8" /> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> 7 8 <title>Install — scikit-tda 1.1.1 documentation</title> 9 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" /> 10 <link rel="stylesheet" type="text/css" href="_static/better.css?v=b2702785" /> 11
11<script src="_static/documentation_options.js?v=58fbf978"></script>
11 12
12<script src="_static/doctools.js?v=fd6eb6e6"></script>
12 13
13<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
13 14
14<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>
14 15 <link rel="index" title="Index" href="genindex.html" /> 16 <link rel="search" title="Search" href="search.html" /> 17 <link rel="next" title="Theory" href="theory.html" /> 18 <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> 19
19<script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script>
19<meta name="readthedocs-project-slug" content="scikit-tda" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head><body> 20 <header id="pageheader"> 21 <h1> 22 <a href="# "> 23 scikit-tda 1.1.1 documentation 24 </a> 25 <a id="headermeta" href="https://scikit-tda.org"> 26 a scikit-tda project 27 </a> 28 </h1> 29 </header> 30 <div class="related top"> 31 <nav id="rellinks"> 32 <ul> 33 <li> 34 <a href="theory.html" title="Next document">Theory</a> 35 → 36 </li> 37 </ul> 38 </nav> 39 <nav id="breadcrumbs"> 40 <ul> 41 <li><a href="#">scikit-tda</a></li> 42 </ul> 43 </nav> 44 </div> 45 46 <div class="document"> 47 <div class="documentwrapper"> 48 <div class="bodywrapper"> 49 <div class="body" role="main"> 50 51 <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://img.shields.io/pypi/v/scikit-tda" /></a> <a class="reference external" href="https://pypi.org/project/scikit-tda/"><img alt="Downloads" src="https://img.shields.io/pypi/dm/scikit-tda" /></a></p> 52<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> 53<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> 54<p>This project is entirely a work in progress and still in an early phase. 55We 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> 56<p>If you would like to contribute, please reach out to us on 57<a class="reference external" href="https://github.com/scikit-tda">github</a> by starting a <a class="reference external" href="https://github.com/orgs/scikit-tda/discussions">discussion topic</a>, 58<a class="reference external" href="https://github.com/scikit-tda/scikit-tda/issues">creating an issue</a>, or reaching out on 59<a class="reference external" href="https://twitter.com/scikit_tda">twitter</a>.</p> 60<section id="install"> 61<h1>Install<a class="headerlink" href="#install" title="Link to this heading">¶</a></h1> 62<p>Installation of all libraries can be done directly from Pypi in one command.</p> 63<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> 64</pre></div> 65</div> 66</section> 67<section id="contact"> 68<h1>Contact<a class="headerlink" href="#contact" title="Link to this heading">¶</a></h1> 69<p>If you would like to contribute and have ideas for how to do so, please reach out! 70If 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> 71</section> 72<section id="contributing"> 73<h1>Contributing<a class="headerlink" href="#contributing" title="Link to this heading">¶</a></h1> 74<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 co
74de merged into the main branch.</p> 75</section> 76<section id="citation"> 77<h1>Citation<a class="headerlink" href="#citation" title="Link to this heading">¶</a></h1> 78<p>For the time being, if you would like to cite Scikit-TDA, please use the following citation/bibtex:</p> 79<blockquote> 80<div><p>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></p> 81</div></blockquote> 82<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> 83 <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> 84 <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> 85 <span class="n">year</span> <span class="o">=</span> <span class="mi">2019</span><span class="p">,</span> 86 <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="mf">.2533369</span><span class="p">},</span> 87 <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="mf">.2533369</span><span class="p">}</span> 88<span class="p">}</span> 89</pre></div> 90</div> 91</section> 92<section id="license"> 93<h1>License<a class="headerlink" href="#license" title="Link to this heading">¶</a></h1> 94<p>This package is licensed with the MIT license.</p> 95<div class="toctree-wrapper compound"> 96</div> 97<div class="toctree-wrapper compound"> 98</div> 99</section> 100 101 102 <div class="clearer"></div> 103 </div> 104 </div> 105 </div> 106 <div class="sphinxsidebar" role="navigation" aria-label="Main"> 107 <div class="sphinxsidebarwrapper"> 108 <p class="logo"><a href="#"> 109 <img class="logo" src="_static/logo.png" alt="Logo of scikit-tda"/> 110 </a></p> 111<form class="search" action="search.html" method="get"> 112 <input type="text" name="q" 113 placeholder="type to search" /> 114 <input type="hidden" name="check_keywords" value="yes" /> 115 <input type="hidden" name="area" value="default" /> 116</form>
117<script type="text/javascript">$('#searchbox').show(0);</script>
117 118 119<a href=https://github.com/scikit-tda> 120 <p class="caption"><span class="caption-text"> 121 <img src="_static/gh_logo.png" 122 height="18px" 123 width="18px" alt="Github icon"> 124 scikit-tda 125 </span></p> 126</a> 127 128<p class="caption" role="heading"><span class="caption-text">User Guide</span></p> 129<ul> 130<li class="toctree-l1"><a class="reference internal" href="theory.html">Theory</a></li> 131<li class="toctree-l1"><a class="reference internal" href="libraries.html">Libraries</a></li> 132</ul> 133<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p> 134<ul> 135<li class="toctree-l1"><a class="reference internal" href="notebooks/scikit-tda%20Tutorial.html">Welcome to scikit-tda tutorial</a></li> 136<li class="toctree-l1"><a class="reference internal" href="notebooks/scikit-tda%20Tutorial.html#Features-of-scikit-tda">Features of scikit-tda</a></li> 137<li class="toctree-l1"><a class="reference internal" href="notebooks/scikit-tda%20Tutorial.html#scikit-tda-install">scikit-tda install</a></li> 138<li class="toctree-l1"><a class="reference internal" href="notebooks/scikit-tda%20Tutorial.html#Overview-of-scikit-tda-modules">Overview of scikit-tda modules</a></li> 139<li class="toctree-l1"><a class="reference internal" href="notebooks/scikit-tda%20Tutorial.html#Outline-of-this-notebook">Outline of this notebook</a></li> 140<li class="toctree-l1"><a class="reference internal" href="notebooks/scikit-tda%20Tutorial.html#1.-Persistence-API">1. Persistence API</a></li> 141<li class="toctree-l1"><a class="reference internal" href="notebooks/scikit-tda%20Tutorial.html#2.-Analysis-of-PDs">2. Analysis of PDs</a></li> 142<li class="toctree-l1"><a class="reference internal" href="notebooks/scikit-tda%20Tutorial.html#3.-Persistence-for-graphs">3. Persistence for graphs</a></li> 143<li class="toctree-l1"><a class="reference internal" href="notebooks/scikit-tda%20Tutorial.html#Thank-you!">Thank you!</a></li> 144</ul> 145 146 </div> 147 </div> 148 <div class="clearer"></div> 149 </div> 150 <div class="related bottom"> 151 <nav id="rellinks"> 152 <ul> 153 <li> 154 <a href="theory.html" title="Next document">Theory</a> 155 → 156 </li> 157 </ul> 158 </nav> 159 <nav id="breadcrumbs"> 160 <ul> 161 <li><a href="#">scikit-tda</a></li> 162 </ul> 163 </nav> 164 </div> 165 <footer id="pagefooter">© 2019, Nathaniel Saul. 166 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 167 9.0.4. 168 169 </footer> 170 171 172
172<script>
vendor: 359 bytes, lines 172-178
172 173 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ 174 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), 175 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) 176 })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); 177 178 ga('create', '
178UA-124965309-1
vendor: 42 bytes, lines 178-180
178', ''); 179 ga('send', 'pageview'); 180
180</script>
180 181 182 </body> 183</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.