Skip to content

Commit

Permalink
merging main with gh-pages
Browse files Browse the repository at this point in the history
R. S. Doiel committed Jul 10, 2024
2 parents b9395df + 89f7b4d commit 2534dbd
Showing 9 changed files with 258 additions and 0 deletions.
235 changes: 235 additions & 0 deletions INSTALL.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,235 @@
<!DOCTYPE html>
<html>
<head>
<title>Caltech Library's Digital Library Development Sandbox</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"><img src="/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="./">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="how-to/">Tutorials</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/datatools">GitHub</a></li>
</ul>
</nav>

<section>
<h1 id="installation">Installation</h1>
<p><em>datatools</em> is a collection of command line programs run from
a shell like Bash.</p>
<h2 id="quick-install-using-curl-or-irm">Quick install using curl or
irm</h2>
<p>The following experimental installer should work for macOS and Linux
(e.g. Debian, Ubuntu, Raspberry Pi OS)</p>
<p>Copy and run the following command in your shell (e.g. Terminal)</p>
<pre><code>curl https://caltechlibrary.github.io/datatools/installer.sh | sh</code></pre>
<p>On Windows use the Powershell script run with</p>
<pre><code>irm https://caltechlibrary.github.io/datatools/installer.ps1 | iex</code></pre>
<p>If you wish to install a specific version then you can set the
<code>PKG_VERSION</code> environment variable before using the curl or
irm comments above.</p>
<p>On Linux, macOS</p>
<pre><code>export PKG_VERSION=&quot;1.2.9&quot;
curl https://caltechlibrary.github.io/datatools/installer.sh | sh</code></pre>
<p>or for Windows</p>
<pre><code>$env:PKG_VERSION = &#39;1.2.9&#39;
irm https://caltechlibrary.github.io/datatools/installer.ps1 | iex</code></pre>
<h2 id="compiled-version">Compiled version</h2>
<p>This is generalized instructions for a release.</p>
<p>Compiled versions are available for Mac OS X (Intel and M1 processor,
macos-x86_64 and macOS-arm64), Linux (Intel process, Linux-x86_64),
Windows (Intel and arm64 processor, windows-x86_64 and Windows-arm64)
and Rapsberry Pi (arm7 processor, RaspberryPiOS-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/datatools/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>datatools-VERSION_NUMBER-Windows-x86_64.zip</td>
</tr>
<tr class="even">
<td>Windows</td>
<td>datatools-VERSION_NUMBER-Windows-arm64.zip</td>
</tr>
<tr class="odd">
<td>Mac OS X</td>
<td>datatools-VERSION_NUMBER-macOS-x86_64.zip</td>
</tr>
<tr class="even">
<td>Mac OS X</td>
<td>datatools-VERSION_NUMBER-macOS-arm64.zip</td>
</tr>
<tr class="odd">
<td>Linux/Intel</td>
<td>datatools-VERSION_NUMBER-Linux-x86_64.zip</td>
</tr>
<tr class="even">
<td>Linux/ARM 64</td>
<td>datatools-VERSION_NUMBER-Linux-aarch64.zip</td>
</tr>
<tr class="odd">
<td>Raspbery Pi OS</td>
<td>datatools-VERSION_NUMBER-RaspberryPiOS-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 Intel style
CPU you’d choose the Zip file with “windows-x86_64” in the name).</li>
</ul></li>
<li>Download the zip file and unzip the file.<br />
</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. export PATH=“<span
class="math inline"><em>H</em><em>O</em><em>M</em><em>E</em>/<em>b</em><em>i</em><em>n</em>:</span>PATH”)</li>
</ul></li>
<li>Test</li>
</ul>
<h3 id="mac-os">Mac OS</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>
<h4 id="intel-x86_64-hardware">Intel (x86_64) Hardware</h4>
<pre class="shell"><code> cd Downloads/
unzip datatools-*-macos-x86_64.zip
mkdir -p $HOME/bin
mv -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
csvfind -version</code></pre>
<h4 id="arm64-arm64-hardware">ARM64 (arm64) Hardware</h4>
<pre class="shell"><code> cd Downloads/
unzip datatools-*-macos-arm64.zip
mkdir -p $HOME/bin
mv -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
csvfind -version</code></pre>
<h3 id="windows">Windows</h3>
<p>(Assumes you’re working from Bash as provided by Linux Subsystem for
Windows)</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 on
Windows 10 after downloading the zip file.</p>
<h4 id="intel-x86_64-hardware-1">Intel (x86_64) Hardware</h4>
<pre class="shell"><code> cd Downloads/
unzip datatools-*-windows-x86_64.zip
mkdir -p $HOME/bin
mv -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
csvfind -version</code></pre>
<h4 id="arm64-arm64-hardware-1">ARM64 (arm64) Hardware</h4>
<pre class="shell"><code> cd Downloads/
unzip datatools-*-windows-arm64.zip
mkdir -p $HOME/bin
mv -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
csvfind -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 datatools-*-linux-x86_64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
csvfind -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 datatools-*-raspberry_pi_os-arm7.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
csvfind -version</code></pre>
<h2 id="compiling-from-source">Compiling from source</h2>
<p><em>datatools</em> is “go gettable” if you have previously gotten
xlsx v1.0.5 package from <a
href="https://github.com/tealeg/xlsx">github.com/tealeg/xlsx</a>. The
datatools package does not support versions v2.x and greater of xlsx.
Below are the steps I use today with “go get” command to download the
dependant packages as well as <em>datatools</em>’s source code.</p>
<p>Setting up the right version of xlsx for datatools</p>
<pre class="shell"><code> cd
go get github.com/tealeg/xlsx
cd src/github.com/tealeg
git checkout v1.0.5
cd</code></pre>
<p>Using <code>go get</code> to install datatools using v1.0.5 of
xlsx.</p>
<pre><code> go get github.com/caltechlibrary/datatools/...</code></pre>
<p>Or clone the repository and then compile</p>
<pre class="shell"><code> cd
git clone https://github.com/caltechlibrary/datatools src/github.com/caltechlibrary/datatools
cd src/github.com/caltechlibrary/datatools
make
make test
make install</code></pre>
</section>

<footer>
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span>
<span>&copy; 2023 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
<span><a href="mailto:library@caltech.edu">Email Us</a></span>
<a class="cl-hide" href="sitemap.xml">Site Map</a>
</footer>
</body>
</html>
19 changes: 19 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -23,6 +23,25 @@ On Windows use the Powershell script run with
irm https://caltechlibrary.github.io/datatools/installer.ps1 | iex
~~~

If you wish to install a specific version then you can set the
`PKG_VERSION` environment variable before using the curl or irm
comments above.

On Linux, macOS

~~~
export PKG_VERSION="1.2.9"
curl https://caltechlibrary.github.io/datatools/installer.sh | sh
~~~

or for Windows

~~~
$env:PKG_VERSION = '1.2.9'
irm https://caltechlibrary.github.io/datatools/installer.ps1 | iex
~~~


Compiled version
----------------

Binary file added pagefind/fragment/unknown_d7e8d31.pf_fragment
Binary file not shown.
Binary file added pagefind/index/unknown_7031905.pf_index
Binary file not shown.
Binary file added pagefind/index/unknown_74a5afc.pf_index
Binary file not shown.
Binary file added pagefind/index/unknown_94d1fae.pf_index
Binary file not shown.
Binary file added pagefind/index/unknown_ba8199f.pf_index
Binary file not shown.
4 changes: 4 additions & 0 deletions pagefind/pagefind-entry.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
{"version":"1.0.4","languages":{"unknown":{"hash":"unknown_136bfd6c27d2e01","wasm":null,"page_count":199}}}
=======
{"version":"1.0.4","languages":{"unknown":{"hash":"unknown_d9c7c23b74d1417","wasm":null,"page_count":119}}}
>>>>>>> a06e328e8659979d5b987a54c3508793c19f274b
=======
{"version":"1.1.0","languages":{"unknown":{"hash":"unknown_89238ff5a91adb5","wasm":null,"page_count":200}}}
>>>>>>> a6447f3a733ff098c0752c9796036b1fd049e933
=======
{"version":"1.1.0","languages":{"unknown":{"hash":"unknown_f4cf25532b13d29","wasm":null,"page_count":200}}}
>>>>>>> 89f7b4dcf8846f004fd9e9934d76b3960f9e11c1
Binary file not shown.

0 comments on commit 2534dbd

Please sign in to comment.