|  | 
 |  | 
 | <!DOCTYPE html> | 
 | <html class="writer-html5" lang="en" > | 
 | <head> | 
 |   <meta charset="utf-8" /> | 
 |    | 
 |   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | 
 |    | 
 |   <title>Envirement Setting — Apache AGE master documentation</title> | 
 |    | 
 |  | 
 |    | 
 |   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> | 
 |   <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | 
 |   <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | 
 |   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> | 
 |   <link rel="stylesheet" href="_static/css/custom.css" type="text/css" /> | 
 |  | 
 |    | 
 |    | 
 |     <link rel="shortcut icon" href="_static/favicon.ico"/> | 
 |    | 
 |  | 
 |    | 
 |    | 
 |  | 
 |    | 
 |  | 
 |    | 
 |   <!--[if lt IE 9]> | 
 |     <script src="_static/js/html5shiv.min.js"></script> | 
 |   <![endif]--> | 
 |    | 
 |      | 
 |       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> | 
 |         <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> | 
 |         <script src="_static/jquery.js"></script> | 
 |         <script src="_static/underscore.js"></script> | 
 |         <script src="_static/doctools.js"></script> | 
 |      | 
 |     <script type="text/javascript" src="_static/js/theme.js"></script> | 
 |  | 
 |      | 
 |     <link rel="index" title="Index" href="genindex.html" /> | 
 |     <link rel="search" title="Search" href="search.html" />  | 
 | </head> | 
 |  | 
 | <body class="wy-body-for-nav"> | 
 |  | 
 |     | 
 |   <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"> Apache AGE | 
 |            | 
 |  | 
 |            | 
 |              | 
 |             <img src="_static/logo.png" class="logo" alt="Logo"/> | 
 |            | 
 |           </a> | 
 |  | 
 |            | 
 |              | 
 |              | 
 |            | 
 |  | 
 |            | 
 | <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"> | 
 |            | 
 |              | 
 |              | 
 |                | 
 |              | 
 |              | 
 |               <p class="caption" role="heading"><span class="caption-text">Introduction</span></p> | 
 | <ul> | 
 | <li class="toctree-l1"><a class="reference internal" href="intro/overview.html">Overview</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="intro/setup.html">Setup</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="intro/graphs.html">Graphs</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="intro/cypher.html">The AGE Cypher Query Format</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="intro/types.html">Data Types - An Introduction to agtype</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="intro/comparability.html">Comparability, Equality, Orderability and Equivalence</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="intro/operators.html">Operators</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="intro/aggregation.html">Aggregation</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="intro/agload.html">Importing graph from files</a></li> | 
 | </ul> | 
 | <p class="caption" role="heading"><span class="caption-text">Clauses</span></p> | 
 | <ul> | 
 | <li class="toctree-l1"><a class="reference internal" href="clauses/match.html">MATCH</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="clauses/with.html">WITH</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="clauses/return.html">RETURN</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="clauses/order_by.html">ORDER BY</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="clauses/skip.html">SKIP</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="clauses/limit.html">LIMIT</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="clauses/create.html">CREATE</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="clauses/delete.html">DELETE</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="clauses/set.html">SET</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="clauses/remove.html">REMOVE</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="clauses/merge.html">MERGE</a></li> | 
 | </ul> | 
 | <p class="caption" role="heading"><span class="caption-text">Functions</span></p> | 
 | <ul> | 
 | <li class="toctree-l1"><a class="reference internal" href="functions/predicate_functions.html">Predicate Functions</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="functions/scalar_functions.html">Scalar Functions</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="functions/list_functions.html">List Functions</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="functions/numeric_functions.html">Numeric Functions</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="functions/logarithmic_functions.html">Logarithmic Functions</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="functions/trigonometric_functions.html">Trigonometric Functions</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="functions/string_functions.html">String Functions</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="functions/aggregate_functions.html">Aggregation Functions</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="functions/user_functions.html">User defined functions</a></li> | 
 | </ul> | 
 | <p class="caption" role="heading"><span class="caption-text">AGE Beyond Cypher</span></p> | 
 | <ul> | 
 | <li class="toctree-l1"><a class="reference internal" href="advanced/advanced_overview.html">Overview</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="advanced/advanced.html">Using Cypher in a CTE Expression</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="advanced/advanced.html#using-cypher-in-a-join-expression">Using Cypher in a Join expression</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="advanced/advanced.html#cypher-in-sql-expressions">Cypher in SQL expressions</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="advanced/prepared_statements.html">Prepared Statements</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="advanced/plpgsql.html">PL/pgSQL Functions</a></li> | 
 | <li class="toctree-l1"><a class="reference internal" href="advanced/sql_in_cypher.html">SQL In Cypher</a></li> | 
 | </ul> | 
 | <p class="caption" role="heading"><span class="caption-text">Contributing</span></p> | 
 | <ul> | 
 | <li class="toctree-l1"><a class="reference internal" href="contributing/run_tests.html">Run the test suite</a></li> | 
 | </ul> | 
 |  | 
 |              | 
 |            | 
 |         </div> | 
 |          | 
 |       </div> | 
 |     </nav> | 
 |  | 
 |     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | 
 |  | 
 |        | 
 |       <nav class="wy-nav-top" aria-label="top navigation"> | 
 |          | 
 |           <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | 
 |           <a href="index.html">Apache AGE</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" class="icon icon-home"></a> »</li> | 
 |          | 
 |       <li>Envirement Setting</li> | 
 |      | 
 |      | 
 |       <li class="wy-breadcrumbs-aside"> | 
 |          | 
 |            | 
 |              | 
 |               <a href="https://github.com/apache/incubator-age-website/blob/master/docs/README.md" class="fa fa-github"> Edit on GitHub</a> | 
 |              | 
 |            | 
 |          | 
 |       </li> | 
 |      | 
 |   </ul> | 
 |  | 
 |    | 
 |   <hr/> | 
 | </div> | 
 |           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | 
 |            <div itemprop="articleBody"> | 
 |              | 
 |   <div class="section" id="envirement-setting"> | 
 | <h1>Envirement Setting<a class="headerlink" href="#envirement-setting" title="Permalink to this headline">¶</a></h1> | 
 | <p><code class="docutils literal notranslate"><span class="pre">virtualenv</span> <span class="pre">-p</span> <span class="pre">python3</span> <span class="pre">venv</span></code></p> | 
 | </div> | 
 | <div class="section" id="activate-the-virtual-environment"> | 
 | <h1>Activate the virtual environment<a class="headerlink" href="#activate-the-virtual-environment" title="Permalink to this headline">¶</a></h1> | 
 | <p><code class="docutils literal notranslate"><span class="pre">source</span> <span class="pre">venv/bin/activate</span></code></p> | 
 | </div> | 
 | <div class="section" id="install-the-python-requirements"> | 
 | <h1>Install the python requirements<a class="headerlink" href="#install-the-python-requirements" title="Permalink to this headline">¶</a></h1> | 
 | <p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-r</span> <span class="pre">requirements.txt</span></code></p> | 
 | </div> | 
 | <div class="section" id="build"> | 
 | <h1>build<a class="headerlink" href="#build" title="Permalink to this headline">¶</a></h1> | 
 | <p><code class="docutils literal notranslate"><span class="pre">sphinx-build</span> <span class="pre">docs</span> <span class="pre">static/age-manual/</span></code></p> | 
 | </div> | 
 |  | 
 |  | 
 |            </div> | 
 |             | 
 |           </div> | 
 |           <footer> | 
 |  | 
 |   <hr/> | 
 |  | 
 |   <div role="contentinfo"> | 
 |     <p> | 
 |         © Copyright 2021, Apache AGE. | 
 |  | 
 |     </p> | 
 |   </div> | 
 |      | 
 |      | 
 |      | 
 |     Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a | 
 |      | 
 |     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> | 
 |      | 
 |     provided by <a href="https://readthedocs.org">Read the Docs</a>.  | 
 |  | 
 | </footer> | 
 |         </div> | 
 |       </div> | 
 |  | 
 |     </section> | 
 |  | 
 |   </div> | 
 |    | 
 | <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> | 
 |   <span class="rst-current-version" data-toggle="rst-current-version"> | 
 |     <span class="fa fa-book"> Other Versions</span> | 
 |     v: manual-link | 
 |     <span class="fa fa-caret-down"></span> | 
 |   </span> | 
 |   <div class="rst-other-versions"> | 
 |     <dl> | 
 |       <dt>Versions</dt> | 
 |       <dd><a href="../documentation-staging/index.html">documentation-staging</a></dd> | 
 |       <dd><a href="README.html">manual-link</a></dd> | 
 |       <dd><a href="../master/index.html">master</a></dd> | 
 |       <dd><a href="../v0.6.0/index.html">v0.6.0</a></dd> | 
 |     </dl> | 
 |   </div> | 
 | </div> | 
 |  | 
 |   <script type="text/javascript"> | 
 |       jQuery(function () { | 
 |           SphinxRtdTheme.Navigation.enable(true); | 
 |       }); | 
 |   </script> | 
 |  | 
 |    | 
 |    | 
 |      | 
 |     | 
 |  | 
 | </body> | 
 | </html> |