install.html

<!DOCTYPE html>
<html>
<head>
    <title>INSTALL</title>
    <link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
    <link rel="stylesheet" href="/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu" title="link to Caltech Library Homepage"><img src="/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
    <li><a href="/">Home</a></li>
    <li><a href="README.html">README</a></li>
    <li><a href="LICENSE">LICENSE</a></li>
    <li><a href="install.html">INSTALL</a></li>
    <li><a href="user_manual.html">User Manual</a></li>
	<li><a href="search.html">Search Docs</a></li>
    <li><a href="about.html">About</a></li>
    <li><a href="https://github.com/caltechlibrary/pairtree">GitHub</a></li>
</ul>
</nav>

<section>
<h1 id="installation">Installation</h1>
<p><em>pairtree</em> is a command line program run from a shell like
Bash. It allows you to organize encode “Name as Text” documents to
provide metadata for a directory.</p>
<h2 id="quick-install-with-curl">Quick install with curl</h2>
<p>If you are running macOS or Linux you can install released versions
of newt with the following curl command.</p>
<pre><code>curl https://caltechlibrary.github.io/pairtree/installer.sh</code></pre>
<h2 id="compiled-version">Compiled version</h2>
<p>Compiled versions are available for Mac OS X (amd64 processor,
macosx-amd64), Linux (amd64 process, linux-amd64), Windows (amd64
processor, windows-amd64) and Rapsberry Pi (arm7 processor,
raspberry_pi_os-arm7)</p>
<p>VERSION_NUMBER is a <a href="http://semver.org/">symantic version
number</a> (e.g. v0.1.2)</p>
<p>For all the released version go to the project page on Github and
click latest release</p>
<blockquote>
<p>https://github.com/caltechlibrary/pairtree/releases/latest</p>
</blockquote>
<table>
<thead>
<tr class="header">
<th>Platform</th>
<th>Zip Filename</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Windows</td>
<td>pairtree-VERSION_NUMBER-windows-amd64.zip</td>
</tr>
<tr class="even">
<td>Mac OS (Intel)</td>
<td>pairtree-VERSION_NUMBER-macos-amd64.zip</td>
</tr>
<tr class="odd">
<td>Mac OS (M1)</td>
<td>pairtree-VERSION_NUMBER-macos-amd64.zip</td>
</tr>
<tr class="even">
<td>Linux/Intel</td>
<td>pairtree-VERSION_NUMBER-linux-amd64.zip</td>
</tr>
<tr class="odd">
<td>Raspbery Pi</td>
<td>pairtree-VERSION_NUMBER-raspberry_pi_os-arm7.zip</td>
</tr>
</tbody>
</table>
<h2 id="the-basic-recipe">The basic recipe</h2>
<ul>
<li>Find the Zip file listed matching the architecture you’re running
and download it
<ul>
<li>(e.g. if you’re on a Windows 10 laptop/Surface with a amd64 style
CPU you’d choose the Zip file with “windows-amd64” in the name).</li>
</ul></li>
<li>Download the zip file and unzip the file.</li>
<li>Copy the contents of the folder named “bin” to a folder that is in
your path
<ul>
<li>(e.g. “$HOME/bin” is common).</li>
</ul></li>
<li>Adjust your PATH if needed
<ul>
<li>(e.g. <code>export PATH="$HOME/bin:$PATH"</code>)</li>
</ul></li>
<li>Test</li>
</ul>
<h3 id="mac-os-x">Mac OS X</h3>
<ol type="1">
<li>Download the zip file</li>
<li>Unzip the zip file</li>
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
<li>Make sure the new location in in our path</li>
<li>Test</li>
</ol>
<p>Here’s an example of the commands run in the Terminal App after
downloading the zip file.</p>
<pre class="shell"><code>    cd Downloads/
    unzip pairtree-*-macosx-amd64.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    pairtree -version</code></pre>
<h3 id="windows">Windows</h3>
<ol type="1">
<li>Download the zip file</li>
<li>Unzip the zip file</li>
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
<li>Test</li>
</ol>
<p>Here’s an example of the commands run in from the Bash shell on
Windows 10 after downloading the zip file.</p>
<pre class="shell"><code>    cd Downloads/
    unzip pairtree-*-windows-amd64.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    pairtree -version</code></pre>
<h3 id="linux">Linux</h3>
<ol type="1">
<li>Download the zip file</li>
<li>Unzip the zip file</li>
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
<li>Test</li>
</ol>
<p>Here’s an example of the commands run in from the Bash shell after
downloading the zip file.</p>
<pre class="shell"><code>    cd Downloads/
    unzip pairtree-*-linux-amd64.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    pairtree -version</code></pre>
<h3 id="raspberry-pi">Raspberry Pi</h3>
<p>Released version is for a Raspberry Pi 2 or later use (i.e. requires
ARM 7 support).</p>
<ol type="1">
<li>Download the zip file</li>
<li>Unzip the zip file</li>
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
<li>Test</li>
</ol>
<p>Here’s an example of the commands run in from the Bash shell after
downloading the zip file.</p>
<pre class="shell"><code>    cd Downloads/
    unzip pairtree-*-raspberry_pi_os-arm7.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    pairtree -version</code></pre>
<h2 id="compiling-from-source">Compiling from source</h2>
<p><em>pairtree</em> is “go gettable”. Use the “go get” command to
download the dependant packages as well as <em>pairtree</em>’s source
code.</p>
<pre class="shell"><code>    go get -u github.com/caltechlibrary/pairtree/...</code></pre>
<p>Or clone the repstory and then compile</p>
<pre class="shell"><code>    cd
    git clone https://github.com/caltechlibrary/pairtree src/github.com/caltechlibrary/pairtree
    cd src/github.com/caltechlibrary/pairtree
    make
    make test
    make install</code></pre>
<p>Compilation assumes <a href="https://github.com/golang/go">go</a>
v1.10 and <a href="https://blevesearh.com">bleve</a> v0.6.0.</p>
</section>

<footer>
<span>&copy; 2021 <a href="https://www.library.caltech.edu/copyright">Caltech Library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span><a href="mailto:library@caltech.edu">Email Us</a></span> 
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
</footer>
<!-- START: PrettyFi from https://github.com/google/code-prettify -->
<script>
/* We want to add the class "prettyprint" to all the pre elements */
var pre_list = document.querySelectorAll("pre");

pre_list.forEach(function(elem) {
    elem.classList.add("prettyprint");
    elem.classList.add("linenums");/**/
    elem.classList.add("json"); /**/
});
</script>
<style>
li.L0, li.L1, li.L2, li.L3, li.L4, li.L5, li.L6, li.L7, li.L8, li.L9
{
    color: #555;
    list-style-type: decimal;
}
</style>
<link rel="stylesheet" type="text/css" href="/css/prettify.css">
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_
prettify.js"></script>
<!--  END: PrettyFi from https://github.com/google/code-prettify -->
</body>
</html>