Skip to content

Commit 8b64067

Browse files
rsdoielrsdoiel
committed
commiting to main
1 parent 5eea8be commit 8b64067

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+1645
-669
lines changed

‎INSTALL.html

Lines changed: 222 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Caltech Library's Digital Library Development Sandbox</title>
5+
<link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
6+
<link rel="stylesheet" href="/css/site.css">
7+
</head>
8+
<body>
9+
<header>
10+
<a href="http://library.caltech.edu"><img src="/assets/liblogo.gif" alt="Caltech Library logo"></a>
11+
</header>
12+
<nav>
13+
<ul>
14+
<li><a href="/">Home</a></li>
15+
<li><a href="./">README</a></li>
16+
<li><a href="LICENSE">LICENSE</a></li>
17+
<li><a href="INSTALL.html">INSTALL</a></li>
18+
<li><a href="user-manual.html">User Manual</a></li>
19+
<li><a href="how-to/">Tutorials</a></li>
20+
<li><a href="about.html">About</a></li>
21+
<li><a href="https://github.com/caltechlibrary/datatools">GitHub</a></li>
22+
</ul>
23+
</nav>
24+
25+
<section>
26+
<h1 id="installation">Installation</h1>
27+
<p><em>datatools</em> is a collection of command line programs run from
28+
a shell like Bash.</p>
29+
<h2 id="quick-install-using-curl">Quick install using curl</h2>
30+
<p>The following experimental installer should work for macOS and Linux
31+
(e.g. Debian, Ubuntu, Raspberry Pi OS)</p>
32+
<p>Copy and run the following command in your shell (e.g. Terminal)</p>
33+
<pre><code>curl https://caltechlibrary.github.io/datatools/installer.sh | sh</code></pre>
34+
<h2 id="compiled-version">Compiled version</h2>
35+
<p>This is generalized instructions for a release.</p>
36+
<p>Compiled versions are available for Mac OS X (Intel and M1 processor,
37+
macos-x86_64 and macOS-arm64), Linux (Intel process, Linux-x86_64),
38+
Windows (Intel and arm64 processor, windows-x86_64 and Windows-arm64)
39+
and Rapsberry Pi (arm7 processor, RaspberryPiOS-arm7)</p>
40+
<p>VERSION_NUMBER is a <a href="http://semver.org/">symantic version
41+
number</a> (e.g. v0.1.2)</p>
42+
<p>For all the released version go to the project page on Github and
43+
click latest release</p>
44+
<blockquote>
45+
<p>https://github.com/caltechlibrary/datatools/releases/latest</p>
46+
</blockquote>
47+
<table>
48+
<thead>
49+
<tr class="header">
50+
<th>Platform</th>
51+
<th>Zip Filename</th>
52+
</tr>
53+
</thead>
54+
<tbody>
55+
<tr class="odd">
56+
<td>Windows</td>
57+
<td>datatools-VERSION_NUMBER-Windows-x86_64.zip</td>
58+
</tr>
59+
<tr class="even">
60+
<td>Windows</td>
61+
<td>datatools-VERSION_NUMBER-Windows-arm64.zip</td>
62+
</tr>
63+
<tr class="odd">
64+
<td>Mac OS X</td>
65+
<td>datatools-VERSION_NUMBER-macOS-x86_64.zip</td>
66+
</tr>
67+
<tr class="even">
68+
<td>Mac OS X</td>
69+
<td>datatools-VERSION_NUMBER-macOS-arm64.zip</td>
70+
</tr>
71+
<tr class="odd">
72+
<td>Linux/Intel</td>
73+
<td>datatools-VERSION_NUMBER-Linux-x86_64.zip</td>
74+
</tr>
75+
<tr class="even">
76+
<td>Linux/ARM 64</td>
77+
<td>datatools-VERSION_NUMBER-Linux-aarch64.zip</td>
78+
</tr>
79+
<tr class="odd">
80+
<td>Raspbery Pi OS</td>
81+
<td>datatools-VERSION_NUMBER-RaspberryPiOS-arm7.zip</td>
82+
</tr>
83+
</tbody>
84+
</table>
85+
<h2 id="the-basic-recipe">The basic recipe</h2>
86+
<ul>
87+
<li>Find the Zip file listed matching the architecture you’re running
88+
and download it
89+
<ul>
90+
<li>(e.g. if you’re on a Windows 10 laptop/Surface with a Intel style
91+
CPU you’d choose the Zip file with “windows-x86_64” in the name).</li>
92+
</ul></li>
93+
<li>Download the zip file and unzip the file.<br />
94+
</li>
95+
<li>Copy the contents of the folder named “bin” to a folder that is in
96+
your path
97+
<ul>
98+
<li>(e.g. “$HOME/bin” is common).</li>
99+
</ul></li>
100+
<li>Adjust your PATH if needed
101+
<ul>
102+
<li>(e.g. export PATH=“<span
103+
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>
104+
</ul></li>
105+
<li>Test</li>
106+
</ul>
107+
<h3 id="mac-os">Mac OS</h3>
108+
<ol type="1">
109+
<li>Download the zip file</li>
110+
<li>Unzip the zip file</li>
111+
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
112+
<li>Make sure the new location in in our path</li>
113+
<li>Test</li>
114+
</ol>
115+
<p>Here’s an example of the commands run in the Terminal App after
116+
downloading the zip file.</p>
117+
<h4 id="intel-x86_64-hardware">Intel (x86_64) Hardware</h4>
118+
<pre class="shell"><code> cd Downloads/
119+
unzip datatools-*-macos-x86_64.zip
120+
mkdir -p $HOME/bin
121+
mv -v bin/* $HOME/bin/
122+
export PATH=$HOME/bin:$PATH
123+
csvfind -version</code></pre>
124+
<h4 id="arm64-arm64-hardware">ARM64 (arm64) Hardware</h4>
125+
<pre class="shell"><code> cd Downloads/
126+
unzip datatools-*-macos-arm64.zip
127+
mkdir -p $HOME/bin
128+
mv -v bin/* $HOME/bin/
129+
export PATH=$HOME/bin:$PATH
130+
csvfind -version</code></pre>
131+
<h3 id="windows">Windows</h3>
132+
<p>(Assumes you’re working from Bash as provided by Linux Subsystem for
133+
Windows)</p>
134+
<ol type="1">
135+
<li>Download the zip file</li>
136+
<li>Unzip the zip file</li>
137+
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
138+
<li>Test</li>
139+
</ol>
140+
<p>Here’s an example of the commands run in from the Bash shell on
141+
Windows 10 after downloading the zip file.</p>
142+
<h4 id="intel-x86_64-hardware-1">Intel (x86_64) Hardware</h4>
143+
<pre class="shell"><code> cd Downloads/
144+
unzip datatools-*-windows-x86_64.zip
145+
mkdir -p $HOME/bin
146+
mv -v bin/* $HOME/bin/
147+
export PATH=$HOME/bin:$PATH
148+
csvfind -version</code></pre>
149+
<h4 id="arm64-arm64-hardware-1">ARM64 (arm64) Hardware</h4>
150+
<pre class="shell"><code> cd Downloads/
151+
unzip datatools-*-windows-arm64.zip
152+
mkdir -p $HOME/bin
153+
mv -v bin/* $HOME/bin/
154+
export PATH=$HOME/bin:$PATH
155+
csvfind -version</code></pre>
156+
<h3 id="linux">Linux</h3>
157+
<ol type="1">
158+
<li>Download the zip file</li>
159+
<li>Unzip the zip file</li>
160+
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
161+
<li>Test</li>
162+
</ol>
163+
<p>Here’s an example of the commands run in from the Bash shell after
164+
downloading the zip file.</p>
165+
<pre class="shell"><code> cd Downloads/
166+
unzip datatools-*-linux-x86_64.zip
167+
mkdir -p $HOME/bin
168+
cp -v bin/* $HOME/bin/
169+
export PATH=$HOME/bin:$PATH
170+
csvfind -version</code></pre>
171+
<h3 id="raspberry-pi">Raspberry Pi</h3>
172+
<p>Released version is for a Raspberry Pi 2 or later use (i.e. requires
173+
ARM 7 support).</p>
174+
<ol type="1">
175+
<li>Download the zip file</li>
176+
<li>Unzip the zip file</li>
177+
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
178+
<li>Test</li>
179+
</ol>
180+
<p>Here’s an example of the commands run in from the Bash shell after
181+
downloading the zip file.</p>
182+
<pre class="shell"><code> cd Downloads/
183+
unzip datatools-*-raspberry_pi_os-arm7.zip
184+
mkdir -p $HOME/bin
185+
cp -v bin/* $HOME/bin/
186+
export PATH=$HOME/bin:$PATH
187+
csvfind -version</code></pre>
188+
<h2 id="compiling-from-source">Compiling from source</h2>
189+
<p><em>datatools</em> is “go gettable” if you have previously gotten
190+
xlsx v1.0.5 package from <a
191+
href="https://github.com/tealeg/xlsx">github.com/tealeg/xlsx</a>. The
192+
datatools package does not support versions v2.x and greater of xlsx.
193+
Below are the steps I use today with “go get” command to download the
194+
dependant packages as well as <em>datatools</em>’s source code.</p>
195+
<p>Setting up the right version of xlsx for datatools</p>
196+
<pre class="shell"><code> cd
197+
go get github.com/tealeg/xlsx
198+
cd src/github.com/tealeg
199+
git checkout v1.0.5
200+
cd</code></pre>
201+
<p>Using <code>go get</code> to install datatools using v1.0.5 of
202+
xlsx.</p>
203+
<pre><code> go get github.com/caltechlibrary/datatools/...</code></pre>
204+
<p>Or clone the repository and then compile</p>
205+
<pre class="shell"><code> cd
206+
git clone https://github.com/caltechlibrary/datatools src/github.com/caltechlibrary/datatools
207+
cd src/github.com/caltechlibrary/datatools
208+
make
209+
make test
210+
make install</code></pre>
211+
</section>
212+
213+
<footer>
214+
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span>
215+
<span>&copy; 2023 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span>
216+
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
217+
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
218+
<span><a href="mailto:[email protected]">Email Us</a></span>
219+
<a class="cl-hide" href="sitemap.xml">Site Map</a>
220+
</footer>
221+
</body>
222+
</html>

0 commit comments

Comments
 (0)