Documentation update

astronomy-commons · Dec 8, 2018 · 878d044 · 878d044
1 parent a3ab722
commit 878d044
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -4,15 +4,21 @@ astronomical data processing based on Apache Spark. AXS provides simple
 Python API to enable fast cross-matching, querying and analysis of data
 from astronomical catalogs.
 
+# Prerequisites
+Before running AXS make sure you have Java (at least v.8) installed and JAVA_HOME variable set.
+
+You will also need Python 3 with numpy, pandas and arrow packages.
+
 # Installing
 To install AXS follow these steps (note that Anaconda installer is planned
 for the future):
 1. Download the latest AXS tarball from the [realeases page](https://github.com/dirac-institute/AXS/releases).
 2. Unpack the tarball to a directory of your choosing.
 3. Set `SPARK_HOME` environment variable to point to the extraction directory.
 4. Add `SPARK_HOME/bin` to your `PATH` variable.
+5. Run the `axs-init-config.sh` script to update `spark-defaults.conf` and `hive-site.xml` files with the exact `SPARK_HOME` path.
 
-And you're got to go!
+And you're good to go!
 
 # Further reading
 Read more about starting and using AXS, and its architecture, in 

diff --git a/docs-build/source/installation.rst b/docs-build/source/installation.rst
@@ -6,6 +6,12 @@ AXS Installation
 Currently the only supported method of installing AXS is the manual installation. Anaconda installer is planned
 for the future.
 
+Prerequisites
+===============
+Before running AXS make sure you have Java (at least v.8) installed and JAVA_HOME variable set.
+
+You will also need Python 3 with numpy, pandas and arrow packages.
+
 Manual installation
 ====================
 To install AXS follow these steps:
@@ -14,7 +20,7 @@ To install AXS follow these steps:
 2. Unpack the tarball to a directory of your choosing.
 3. Set `SPARK_HOME` environment variable to point to the extraction directory.
 4. Add `SPARK_HOME/bin` to your `PATH` variable.
-
+5. Run the `axs-init-config.sh` script to update `spark-defaults.conf` and `hive-site.xml` files with the exact `SPARK_HOME` path.
 
 Using Anaconda
 ===============

diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt
@@ -6,6 +6,12 @@ AXS Installation
 Currently the only supported method of installing AXS is the manual installation. Anaconda installer is planned
 for the future.
 
+Prerequisites
+===============
+Before running AXS make sure you have Java (at least v.8) installed and JAVA_HOME variable set.
+
+You will also need Python 3 with numpy, pandas and arrow packages.
+
 Manual installation
 ====================
 To install AXS follow these steps:
@@ -14,7 +20,7 @@ To install AXS follow these steps:
 2. Unpack the tarball to a directory of your choosing.
 3. Set `SPARK_HOME` environment variable to point to the extraction directory.
 4. Add `SPARK_HOME/bin` to your `PATH` variable.
-
+5. Run the `axs-init-config.sh` script to update `spark-defaults.conf` and `hive-site.xml` files with the exact `SPARK_HOME` path.
 
 Using Anaconda
 ===============

diff --git a/docs/index.html b/docs/index.html
@@ -48,6 +48,7 @@ <h1>Welcome to AXS’s documentation!<a class="headerlink" href="#welcome-to-axs
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">AXS Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#prerequisites">Prerequisites</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#manual-installation">Manual installation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#using-anaconda">Using Anaconda</a></li>
 </ul>

diff --git a/docs/installation.html b/docs/installation.html
@@ -35,6 +35,11 @@
 <h1>AXS Installation<a class="headerlink" href="#axs-installation" title="Permalink to this headline">¶</a></h1>
 <p>Currently the only supported method of installing AXS is the manual installation. Anaconda installer is planned
 for the future.</p>
+<div class="section" id="prerequisites">
+<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
+<p>Before running AXS make sure you have Java (at least v.8) installed and JAVA_HOME variable set.</p>
+<p>You will also need Python 3 with numpy, pandas and arrow packages.</p>
+</div>
 <div class="section" id="manual-installation">
 <h2>Manual installation<a class="headerlink" href="#manual-installation" title="Permalink to this headline">¶</a></h2>
 <p>To install AXS follow these steps:</p>
@@ -43,6 +48,7 @@ <h2>Manual installation<a class="headerlink" href="#manual-installation" title="
 <li>Unpack the tarball to a directory of your choosing.</li>
 <li>Set <cite>SPARK_HOME</cite> environment variable to point to the extraction directory.</li>
 <li>Add <cite>SPARK_HOME/bin</cite> to your <cite>PATH</cite> variable.</li>
+<li>Run the <cite>axs-init-config.sh</cite> script to update <cite>spark-defaults.conf</cite> and <cite>hive-site.xml</cite> files with the exact <cite>SPARK_HOME</cite> path.</li>
 </ol>
 </div>
 <div class="section" id="using-anaconda">
@@ -59,6 +65,7 @@ <h2>Using Anaconda<a class="headerlink" href="#using-anaconda" title="Permalink
   <h3><a href="index.html">Table Of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">AXS Installation</a><ul>
+<li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#manual-installation">Manual installation</a></li>
 <li><a class="reference internal" href="#using-anaconda">Using Anaconda</a></li>
 </ul>