--- a +++ b/docs/_build/html/getting-started.html @@ -0,0 +1,125 @@ + +<!DOCTYPE html> + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta charset="utf-8" /> + <title>Getting started — WSITools 0.1 documentation</title> + <link rel="stylesheet" href="_static/classic.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="Example Commands" href="example-commands.html" /> + <link rel="prev" title="WSITools documentation!" href="index.html" /> + </head><body> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="example-commands.html" title="Example Commands" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="index.html" title="WSITools documentation!" + accesskey="P">previous</a> |</li> + <li class="nav-item nav-item-0"><a href="index.html">WSITools 0.1 documentation</a> »</li> + </ul> + </div> + + <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> +<div class="section" id="quick-start"> +<h2>Quick Start<a class="headerlink" href="#quick-start" title="Permalink to this headline">¶</a></h2> +<div class="section" id="installation"> +<h3>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h3> +<p>git clone <a class="reference external" href="https://github.com/smujiang/WSITools.git">https://github.com/smujiang/WSITools.git</a> +cd WSITools +python setup.py install</p> +<p>Note that when you install our package, the dependencies can be automatically installed, but you may need to install +the dependent <a class="reference external" href="https://openslide.org">OpenSlide</a> library. +If using <cite>PyCharm</cite> or <cite>venv</cite> on Windows: +1. Download the correct <a class="reference external" href="https://openslide.org/download/#windows-binaries">binary</a> file for your system +2. Copy all files from <cite>/bin</cite> into your <cite>venv/Scripts/</cite> directory</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="#quick-start">Quick Start</a><ul> +<li><a class="reference internal" href="#installation">Installation</a></li> +</ul> +</li> +</ul> +</li> +</ul> + + <h4>Previous topic</h4> + <p class="topless"><a href="index.html" + title="previous chapter">WSITools documentation!</a></p> + <h4>Next topic</h4> + <p class="topless"><a href="example-commands.html" + title="next chapter">Example Commands</a></p> + <div role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="_sources/getting-started.rst.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + >index</a></li> + <li class="right" > + <a href="example-commands.html" title="Example Commands" + >next</a> |</li> + <li class="right" > + <a href="index.html" title="WSITools documentation!" + >previous</a> |</li> + <li class="nav-item nav-item-0"><a href="index.html">WSITools 0.1 documentation</a> »</li> + </ul> + </div> + <div class="footer" role="contentinfo"> + © Copyright . + Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1. + </div> + </body> +</html> \ No newline at end of file