Skip to content

Commit 681c112

Browse files
author
R. S. Doiel
committed
Quick Save
1 parent 1b11c42 commit 681c112

36 files changed

+307
-34
lines changed

‎INSTALL.html‎

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

‎codemeta-ps1-installer.tmpl‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
#!/usr/bin/env pwsh
2+
# Generated with codemeta-ps1-installer.tmpl, see https://github.com/caltechlibrary/codemeta-pandoc-examples
3+
4+
#
5+
# Set the package name and version to install
6+
#
7+
$$PACKAGE = "$name$"
8+
$$VERSION = "$version$"
9+
$$GIT_GROUP = "$git_org_or_person$"
10+
$$RELEASE = "https://github.com/$${GIT_GROUP}/$${PACKAGE}/releases/tag/v$${VERSION}"
11+
$$SYSTEM_TYPE = Get-ComputerInfo -Property CsSystemType
12+
if ($$SYSTEM_TYPE.CsSystemType.Contains("ARM64")) {
13+
$$MACHINE = "arm64"
14+
} else {
15+
$$MACHINE = "x86_64"
16+
}
17+
18+
# FIGURE OUT Install directory
19+
$$BIN_DIR = "$${Home}\bin"
20+
Write-Output "$${PACKAGE} will be installed in $${BIN_DIR}"
21+
22+
#
23+
# Figure out what the zip file is named
24+
#
25+
$$ZIPFILE = "$${PACKAGE}-v$${VERSION}-Windows-$${MACHINE}.zip"
26+
27+
#
28+
# Check to see if this zip file has been downloaded.
29+
#
30+
$$DOWNLOAD_URL = "https://github.com/$${GIT_GROUP}/$${PACKAGE}/releases/download/v$${VERSION}/$${ZIPFILE}"
31+
32+
if (!(Test-Path $$BIN_DIR)) {
33+
New-Item $$BIN_DIR -ItemType Directory | Out-Null
34+
}
35+
curl.exe -Lo "$${ZIPFILE}" "$${DOWNLOAD_URL}"
36+
37+
tar.exe xf "$${ZIPFILE}" -C "$${Home}"
38+
39+
Remove-Item $$ZIPFILE
40+
41+
$$User = [System.EnvironmentVariableTarget]::User
42+
$$Path = [System.Environment]::GetEnvironmentVariable('Path', $$User)
43+
if (!(";$${Path};".ToLower() -like "*;$${BIN_DIR};*".ToLower())) {
44+
[System.Environment]::SetEnvironmentVariable('Path', "$${Path};$${BIN_DIR}", $$User)
45+
$$Env:Path += ";$${BIN_DIR}"
46+
}
47+
48+
Write-Output "$${PACKAGE} was installed successfully to $${BIN_DIR}"

‎codemeta2cff.1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
%codemeta2cff(1) user manual | version 1.2.9 702ceba
1+
%codemeta2cff(1) user manual | version 1.2.9 1b11c42
22
% R. S. Doiel
33
% 2024-07-09
44

‎csv2json.1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
%csv2json(1) user manual | version 1.2.9 702ceba
1+
%csv2json(1) user manual | version 1.2.9 1b11c42
22
% R. S. Doiel
33
% 2024-07-09
44

‎csv2mdtable.1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
%csv2mdtable(1) user manual | version 1.2.9 702ceba
1+
%csv2mdtable(1) user manual | version 1.2.9 1b11c42
22
% R. S. Doiel
33
% 2024-07-09
44

‎csv2tab.1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
%csv2tab(1) user manual | version 1.2.9 702ceba
1+
%csv2tab(1) user manual | version 1.2.9 1b11c42
22
% R. S. Doiel
33
% 2024-07-09
44

‎csv2xlsx.1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
%csv2xlsx(1) user manual | version 1.2.9 702ceba
1+
%csv2xlsx(1) user manual | version 1.2.9 1b11c42
22
% R. S. Doiel
33
% 2024-07-09
44

‎csvcleaner.1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
%csvcleaner(1) user manual | version 1.2.9 702ceba
1+
%csvcleaner(1) user manual | version 1.2.9 1b11c42
22
% R. S. Doiel
33
% 2024-07-09
44

‎csvcols.1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
%csvcols(1) user manual | version 1.2.9 702ceba
1+
%csvcols(1) user manual | version 1.2.9 1b11c42
22
% R. S. Doiel
33
% 2024-07-09
44

‎csvfind.1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
%csvfind(1) user manual | version 1.2.9 702ceba
1+
%csvfind(1) user manual | version 1.2.9 1b11c42
22
% R. S. Doiel
33
% 2024-07-09
44

0 commit comments

Comments
 (0)