deploy: 5c9cd25

_sources/user_docs/basic_usage.rst.txt

@@ -106,7 +106,7 @@ You can call the ``set_symbol`` method on derived fields for labelling axes when
 
   >>> pressure50 = gasdens50 * gasenergy50**2
   >>> print(pressure50.symbol)
-  \Sigma_\mathrm{g} \times c_\mathrm{s}^2
+  \\mathit{Sigma}_\mathrm{g} \times c_\mathrm{s}^2
   >>> pressure50.set_symbol("P")
   >>> print(pressure50.symbol)
   P

_sources/user_docs/installation.rst.txt

@@ -1,6 +1,25 @@
 Installation
 ============
 
+From PyPI
+---------
+
+Create a virtual environment to keep the Python packages separate from system packages and other local environments::
+
+  $ python -m venv .venv
+
+Activate the environment::
+
+  $ source .venv/bin/activate
+
+Install the dependencies::
+
+  $ pip install Fargonaut
+
+
+From source
+-----------
+
 The only requirements for installing Fargonaut are `Git`_ and `Python`_.
 
 Assuming you have these installed, first, clone the repository::

user_docs.html

@@ -83,7 +83,11 @@
 <h1>User Documentation<a class="headerlink" href="#user-documentation" title="Link to this heading"></a></h1>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="user_docs/installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user_docs/installation.html">Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user_docs/installation.html#from-pypi">From PyPI</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user_docs/installation.html#from-source">From source</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="user_docs/basic_usage.html">Basic Usage</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="user_docs/basic_usage.html#opening-an-output">Opening an output</a></li>
 <li class="toctree-l2"><a class="reference internal" href="user_docs/basic_usage.html#opening-field-data-files">Opening field data files</a></li>

user_docs/basic_usage.html

@@ -188,7 +188,7 @@ <h2>Operations on fields<a class="headerlink" href="#operations-on-fields" title
 <p>You can call the <code class="docutils literal notranslate"><span class="pre">set_symbol</span></code> method on derived fields for labelling axes when plotting:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">pressure50</span> <span class="o">=</span> <span class="n">gasdens50</span> <span class="o">*</span> <span class="n">gasenergy50</span><span class="o">**</span><span class="mi">2</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">pressure50</span><span class="o">.</span><span class="n">symbol</span><span class="p">)</span>
-<span class="go">\Sigma_\mathrm{g} \times c_\mathrm{s}^2</span>
+<span class="go">\\mathit{Sigma}_\mathrm{g} \times c_\mathrm{s}^2</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">pressure50</span><span class="o">.</span><span class="n">set_symbol</span><span class="p">(</span><span class="s2">&quot;P&quot;</span><span class="p">)</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">pressure50</span><span class="o">.</span><span class="n">symbol</span><span class="p">)</span>
 <span class="go">P</span>

user_docs/installation.html

@@ -47,7 +47,11 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1 current"><a class="reference internal" href="../user_docs.html">User Documentation</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Installation</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Installation</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#from-pypi">From PyPI</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#from-source">From source</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="basic_usage.html">Basic Usage</a></li>
 </ul>
 </li>
@@ -81,6 +85,23 @@
 
   <section id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
+<section id="from-pypi">
+<h2>From PyPI<a class="headerlink" href="#from-pypi" title="Link to this heading"></a></h2>
+<p>Create a virtual environment to keep the Python packages separate from system packages and other local environments:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python -m venv .venv
+</pre></div>
+</div>
+<p>Activate the environment:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ source .venv/bin/activate
+</pre></div>
+</div>
+<p>Install the dependencies:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install Fargonaut
+</pre></div>
+</div>
+</section>
+<section id="from-source">
+<h2>From source<a class="headerlink" href="#from-source" title="Link to this heading"></a></h2>
 <p>The only requirements for installing Fargonaut are <a class="reference external" href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">Git</a> and <a class="reference external" href="https://www.python.org/downloads/">Python</a>.</p>
 <p>Assuming you have these installed, first, clone the repository:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/dc2917/Fargonaut
@@ -99,6 +120,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Link to this h
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install -r requirements.txt
 </pre></div>
 </div>
+</section>
 </section>