Skip to content

Commit 48f6f20

Browse files
rsdoielrsdoiel
committed
commiting to main
1 parent 424c191 commit 48f6f20

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

+870
-1403
lines changed

‎INSTALL.html‎

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
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 a shell like Bash.</p>
28+
<h2 id="quick-install-using-curl">Quick install using curl</h2>
29+
<p>The following experimental installer should work for macOS and Linux (e.g. Debian, Ubuntu, Raspberry Pi OS)</p>
30+
<p>Copy and run the following command in your shell (e.g. Terminal)</p>
31+
<pre><code>curl https://caltechlibrary.github.io/datatools/installer.sh | sh</code></pre>
32+
<h2 id="compiled-version">Compiled version</h2>
33+
<p>This is generalized instructions for a release.</p>
34+
<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>
35+
<p>VERSION_NUMBER is a <a href="http://semver.org/">symantic version number</a> (e.g. v0.1.2)</p>
36+
<p>For all the released version go to the project page on Github and click latest release</p>
37+
<blockquote>
38+
<p>https://github.com/caltechlibrary/datatools/releases/latest</p>
39+
</blockquote>
40+
<table>
41+
<thead>
42+
<tr class="header">
43+
<th>Platform</th>
44+
<th>Zip Filename</th>
45+
</tr>
46+
</thead>
47+
<tbody>
48+
<tr class="odd">
49+
<td>Windows</td>
50+
<td>datatools-VERSION_NUMBER-Windows-x86_64.zip</td>
51+
</tr>
52+
<tr class="even">
53+
<td>Windows</td>
54+
<td>datatools-VERSION_NUMBER-Windows-arm64.zip</td>
55+
</tr>
56+
<tr class="odd">
57+
<td>Mac OS X</td>
58+
<td>datatools-VERSION_NUMBER-macOS-x86_64.zip</td>
59+
</tr>
60+
<tr class="even">
61+
<td>Mac OS X</td>
62+
<td>datatools-VERSION_NUMBER-macOS-arm64.zip</td>
63+
</tr>
64+
<tr class="odd">
65+
<td>Linux/Intel</td>
66+
<td>datatools-VERSION_NUMBER-Linux-x86_64.zip</td>
67+
</tr>
68+
<tr class="even">
69+
<td>Linux/ARM 64</td>
70+
<td>datatools-VERSION_NUMBER-Linux-aarch64.zip</td>
71+
</tr>
72+
<tr class="odd">
73+
<td>Raspbery Pi OS</td>
74+
<td>datatools-VERSION_NUMBER-RaspberryPiOS-arm7.zip</td>
75+
</tr>
76+
</tbody>
77+
</table>
78+
<h2 id="the-basic-recipe">The basic recipe</h2>
79+
<ul>
80+
<li>Find the Zip file listed matching the architecture you’re running and download it
81+
<ul>
82+
<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>
83+
</ul></li>
84+
<li>Download the zip file and unzip the file.<br />
85+
</li>
86+
<li>Copy the contents of the folder named “bin” to a folder that is in your path
87+
<ul>
88+
<li>(e.g. “$HOME/bin” is common).</li>
89+
</ul></li>
90+
<li>Adjust your PATH if needed
91+
<ul>
92+
<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>
93+
</ul></li>
94+
<li>Test</li>
95+
</ul>
96+
<h3 id="mac-os">Mac OS</h3>
97+
<ol type="1">
98+
<li>Download the zip file</li>
99+
<li>Unzip the zip file</li>
100+
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
101+
<li>Make sure the new location in in our path</li>
102+
<li>Test</li>
103+
</ol>
104+
<p>Here’s an example of the commands run in the Terminal App after downloading the zip file.</p>
105+
<h4 id="intel-x86_64-hardware">Intel (x86_64) Hardware</h4>
106+
<pre class="shell"><code> cd Downloads/
107+
unzip datatools-*-macos-x86_64.zip
108+
mkdir -p $HOME/bin
109+
mv -v bin/* $HOME/bin/
110+
export PATH=$HOME/bin:$PATH
111+
csvfind -version</code></pre>
112+
<h4 id="arm64-arm64-hardware">ARM64 (arm64) Hardware</h4>
113+
<pre class="shell"><code> cd Downloads/
114+
unzip datatools-*-macos-arm64.zip
115+
mkdir -p $HOME/bin
116+
mv -v bin/* $HOME/bin/
117+
export PATH=$HOME/bin:$PATH
118+
csvfind -version</code></pre>
119+
<h3 id="windows">Windows</h3>
120+
<p>(Assumes you’re working from Bash as provided by Linux Subsystem for Windows)</p>
121+
<ol type="1">
122+
<li>Download the zip file</li>
123+
<li>Unzip the zip file</li>
124+
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
125+
<li>Test</li>
126+
</ol>
127+
<p>Here’s an example of the commands run in from the Bash shell on Windows 10 after downloading the zip file.</p>
128+
<h4 id="intel-x86_64-hardware-1">Intel (x86_64) Hardware</h4>
129+
<pre class="shell"><code> cd Downloads/
130+
unzip datatools-*-windows-x86_64.zip
131+
mkdir -p $HOME/bin
132+
mv -v bin/* $HOME/bin/
133+
export PATH=$HOME/bin:$PATH
134+
csvfind -version</code></pre>
135+
<h4 id="arm64-arm64-hardware-1">ARM64 (arm64) Hardware</h4>
136+
<pre class="shell"><code> cd Downloads/
137+
unzip datatools-*-windows-arm64.zip
138+
mkdir -p $HOME/bin
139+
mv -v bin/* $HOME/bin/
140+
export PATH=$HOME/bin:$PATH
141+
csvfind -version</code></pre>
142+
<h3 id="linux">Linux</h3>
143+
<ol type="1">
144+
<li>Download the zip file</li>
145+
<li>Unzip the zip file</li>
146+
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
147+
<li>Test</li>
148+
</ol>
149+
<p>Here’s an example of the commands run in from the Bash shell after downloading the zip file.</p>
150+
<pre class="shell"><code> cd Downloads/
151+
unzip datatools-*-linux-x86_64.zip
152+
mkdir -p $HOME/bin
153+
cp -v bin/* $HOME/bin/
154+
export PATH=$HOME/bin:$PATH
155+
csvfind -version</code></pre>
156+
<h3 id="raspberry-pi">Raspberry Pi</h3>
157+
<p>Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM 7 support).</p>
158+
<ol type="1">
159+
<li>Download the zip file</li>
160+
<li>Unzip the zip file</li>
161+
<li>Copy the executables to $HOME/bin (or a folder in your path)</li>
162+
<li>Test</li>
163+
</ol>
164+
<p>Here’s an example of the commands run in from the Bash shell after downloading the zip file.</p>
165+
<pre class="shell"><code> cd Downloads/
166+
unzip datatools-*-raspberry_pi_os-arm7.zip
167+
mkdir -p $HOME/bin
168+
cp -v bin/* $HOME/bin/
169+
export PATH=$HOME/bin:$PATH
170+
csvfind -version</code></pre>
171+
<h2 id="compiling-from-source">Compiling from source</h2>
172+
<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>
173+
<p>Setting up the right version of xlsx for datatools</p>
174+
<pre class="shell"><code> cd
175+
go get github.com/tealeg/xlsx
176+
cd src/github.com/tealeg
177+
git checkout v1.0.5
178+
cd</code></pre>
179+
<p>Using <code>go get</code> to install datatools using v1.0.5 of xlsx.</p>
180+
<pre><code> go get github.com/caltechlibrary/datatools/...</code></pre>
181+
<p>Or clone the repository and then compile</p>
182+
<pre class="shell"><code> cd
183+
git clone https://github.com/caltechlibrary/datatools src/github.com/caltechlibrary/datatools
184+
cd src/github.com/caltechlibrary/datatools
185+
make
186+
make test
187+
make install</code></pre>
188+
</section>
189+
190+
<footer>
191+
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span>
192+
<span>&copy; 2023 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span>
193+
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
194+
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
195+
<span><a href="mailto:[email protected]">Email Us</a></span>
196+
<a class="cl-hide" href="sitemap.xml">Site Map</a>
197+
</footer>
198+
</body>
199+
</html>

0 commit comments

Comments
 (0)