| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Installation Guide — UserAle 1.0.4 documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| |
| |
| <link rel="top" title="UserAle 1.0.4 documentation" href="index.html"/> |
| <link rel="next" title="Quickstart Guide" href="quickstart.html"/> |
| <link rel="prev" title="UserAle" href="index.html"/> |
| |
| |
| <script src="_static/js/modernizr.min.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| <div class="wy-grid-for-nav"> |
| |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search"> |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> UserAle |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.0.4 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#installing-userale">Installing UserAle</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#installing-userale-in-an-virtual-environment">Installing UserAle in an Virtual Environment</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#installing-documentation">Installing Documentation</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart Guide</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="userale.html">ALE Library</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to UserAle.pyqt5</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">UserAle</a> |
| </nav> |
| |
| |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html">Docs</a> »</li> |
| |
| <li>Installation Guide</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="installation-guide"> |
| <span id="installation"></span><h1>Installation Guide<a class="headerlink" href="#installation-guide" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="requirements"> |
| <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2> |
| <ul class="simple"> |
| <li>Python 3.5 or above</li> |
| <li>PyQt5, version 5.3 or above</li> |
| <li>pip3, see requirements.txt</li> |
| </ul> |
| </div> |
| <div class="section" id="installing-userale"> |
| <h2>Installing UserAle<a class="headerlink" href="#installing-userale" title="Permalink to this headline">¶</a></h2> |
| <p>The first step is to install UserAle. First, checkout the latest version of UserAle from our Github repository.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ git clone https://github.com/draperlaboratory/userale.pyqt5.git |
| </pre></div> |
| </div> |
| <p>UserAle is a python3 project, so it can be installed like any other python library. Several operating systems (Mac OS X, Major Versions of Linux/BSD) have Python3 pre-installed, so you should just have to run</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ easy_install3 userale |
| </pre></div> |
| </div> |
| <p>or</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ pip3 install userale |
| </pre></div> |
| </div> |
| <p>Users are strongly recommended to install UserAle in a virtualenv. Instructions to setup an virtual environment will be explained below.</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">UserAle.pyqt5 requires that PyQt5 and the Qt5 bindings has been installed. Instructions to install PyQt5 and Qt5 in a virtual environment will be left to the user.</p> |
| </div> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">When the package is installed via <code class="docutils literal"><span class="pre">easy_install3</span></code> or <code class="docutils literal"><span class="pre">pip3</span></code> this function will be bound to the <code class="docutils literal"><span class="pre">userale</span></code> executable in the Python installation’s <code class="docutils literal"><span class="pre">bin</span></code> directory (on Windows - the <code class="docutils literal"><span class="pre">Scripts</span></code> directory).</p> |
| </div> |
| </div> |
| <div class="section" id="installing-userale-in-an-virtual-environment"> |
| <h2>Installing UserAle in an Virtual Environment<a class="headerlink" href="#installing-userale-in-an-virtual-environment" title="Permalink to this headline">¶</a></h2> |
| <p>There are multiple ways to create virtual environments for a Python3 application. virtualenv is a one of those tools to create isolated Python environments. virtualenv creates a folder which contains all the necessary executables to use the packages that the UserAle project would need.</p> |
| <p>Start by changing directory into the root of UserAle’s project directory, and then use the virtualenv command-line tool to create a new environment:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ virtualenv --python=/usr/bin/python3 env |
| </pre></div> |
| </div> |
| <p>Optionally, Python3 has built in support for virtual environments.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ mkdir env |
| $ python3 -m venv env |
| </pre></div> |
| </div> |
| <p>Activate environment:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ source env/bin/activate |
| </pre></div> |
| </div> |
| <p>Install UserAle requirements:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ env/bin/pip3 -r requirements.txt |
| </pre></div> |
| </div> |
| <p>To build the source code and run all unit tests.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ env/bin/python3 setup.py develop test |
| </pre></div> |
| </div> |
| <p>Deactivate environment</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ deactivate |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="installing-documentation"> |
| <h2>Installing Documentation<a class="headerlink" href="#installing-documentation" title="Permalink to this headline">¶</a></h2> |
| <p>To save yourself the trouble, all up to date documentation is available at <a class="reference external" href="https://draperlaboratory.github.io/userale.pyqt5/">https://draperlaboratory.github.io/userale.pyqt5/</a>.</p> |
| <p>However, if you want to manully build the documentation, the instructions are below.</p> |
| <p>To build UserAle’s documentation, create a directory at the root level of <code class="docutils literal"><span class="pre">/userale.pyqt5</span></code> called userale.pyqt5-docs.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ mkdir userale.pyqt5-docs & cd userale.pyqt5-docs |
| </pre></div> |
| </div> |
| <p>Execute build command:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span># Inside top-level docs/ directory. |
| $ make html |
| </pre></div> |
| </div> |
| <p>This should build the documentation in your shell, and output HTML. At then end, it should say something about documents being ready in <code class="docutils literal"><span class="pre">userale.pyqt5-docs/html</span></code>.</p> |
| <p>You can now open them in your browser by typing</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span>$ open userale.pyqt5-docs/html/index.html |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="quickstart.html" class="btn btn-neutral float-right" title="Quickstart Guide" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="index.html" class="btn btn-neutral" title="UserAle" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright 2016, The Charles Stark Draper Laboratory.. |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'./', |
| VERSION:'1.0.4', |
| 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/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |
