/usr/share/doc/python-dtcwt-doc/html/gettingstarted.html is in python-dtcwt-doc 0.11.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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="Content-Type" content="text/html; charset=utf-8" />
<title>Getting Started — dtcwt 0.11.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.11.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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/MathJax.js"></script>
<link rel="top" title="dtcwt 0.11.0 documentation" href="index.html" />
<link rel="next" title="Performing the DTCWT" href="transforms.html" />
<link rel="prev" title="The dtcwt library" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="getting-started">
<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
<p>This library provides support for computing 1D, 2D and 3D dual-tree complex
wavelet transforms and their inverse in Python along with some signal
processing algorithms which make use of the DTCWT.</p>
<p>This section will guide you through using the <code class="docutils literal"><span class="pre">dtcwt</span></code> library. See
<a class="reference internal" href="reference.html"><em>API Reference</em></a> for full details on the library’s API.</p>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>The easiest way to install <code class="docutils literal"><span class="pre">dtcwt</span></code> is via <code class="docutils literal"><span class="pre">easy_install</span></code> or <code class="docutils literal"><span class="pre">pip</span></code>:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> pip install dtcwt
</pre></div>
</div>
<p>If you want to check out the latest in-development version, look at
<a class="reference external" href="https://github.com/rjw57/dtcwt">the project’s GitHub page</a>. Once checked out,
installation is based on setuptools and follows the usual conventions for a
Python project:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> python setup.py install
</pre></div>
</div>
<p>(Although the <cite>develop</cite> command may be more useful if you intend to perform any
significant modification to the library.) A test suite is provided so that you
may verify the code works on your system:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> pip install -r tests/requirements.txt
<span class="gp">$</span> py.test
</pre></div>
</div>
<p>This will also write test-coverage information to the <code class="docutils literal"><span class="pre">cover/</span></code> directory.</p>
<div class="section" id="building-the-documentation">
<h3>Building the documentation<a class="headerlink" href="#building-the-documentation" title="Permalink to this headline">¶</a></h3>
<p>There is <a class="reference external" href="https://dtcwt.readthedocs.org/">a pre-built</a> version of this
documentation available online and you can build your own copy via the Sphinx
documentation system:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> python setup.py build_sphinx
</pre></div>
</div>
<p>Compiled documentation may be found in <code class="docutils literal"><span class="pre">build/docs/html/</span></code>.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Getting Started</a><ul>
<li><a class="reference internal" href="#installation">Installation</a><ul>
<li><a class="reference internal" href="#building-the-documentation">Building the documentation</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">The dtcwt library</a></li>
<li>Next: <a href="transforms.html" title="next chapter">Performing the DTCWT</a></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/gettingstarted.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2013, 2014, Rich Wareham, Nick Kingsbury, Cian Shaffrey.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
<a href="_sources/gettingstarted.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|