-r--r--r-- 7287 holtrace-20250703/doc/html/install.html raw
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type="text/css">
html{overflow-y:scroll;background-color:#505050}
body{font-family:"Noto Sans","Droid Sans","DejaVu Sans","Arial",sans-serif;line-height:1.5}
tt,code{background-color:#f0f0f0;font-family:"Noto Sans Mono","Droid Sans Mono","DejaVu Sans Mono","Courier New",monospace,sans-serif;font-size:1em;}
pre{margin-left:3em}
p,ul,ol,blockquote,pre{font-size:1.0em;line-height:1.6}
li p{font-size:1.0em}
blockquote p{font-size:1.0em}
h1{font-size:1.5em}
h2{font-size:1.3em}
h3{font-size:1.0em}
h1 a{text-decoration:none}
table{border-collapse:collapse}
th,td{border:1px solid black}
table a{text-decoration:none}
table tr{font-size:1.0em;line-height:1.6em}
table tr{font-size:1.0em;line-height:1.5}
tbody tr:nth-child(12n+1){background-color:#f0ffff}
tbody tr:nth-child(12n+2){background-color:#f0ffff}
tbody tr:nth-child(12n+3){background-color:#f0ffff}
tbody tr:nth-child(12n+4){background-color:#f0ffff}
tbody tr:nth-child(12n+5){background-color:#f0ffff}
tbody tr:nth-child(12n+6){background-color:#f0ffff}
tbody tr:nth-child(12n+7){background-color:#fffff0}
tbody tr:nth-child(12n+8){background-color:#fffff0}
tbody tr:nth-child(12n+9){background-color:#fffff0}
tbody tr:nth-child(12n+10){background-color:#fffff0}
tbody tr:nth-child(12n+11){background-color:#fffff0}
tbody tr:nth-child(12n+12){background-color:#fffff0}
#headline{display:block;margin:0;padding:0;color:#ffffff;background-color:#505050}
#headline .text{font-weight:bold;font-size:1.0em}
#headline input{display:none}
#nav ul{margin:0;padding:0}
#nav li{list-style-type:none;margin:0;padding:0}
.navtop{padding-bottom:0.5em;font-weight:bold;font-size:1.0em}
.navtop{background-color:#505050;color:#ffffff}
#nav .here{background-color:#505050;color:#ffffff}
#nav .away{background-color:#505050;color:#ffffff}
#nav .away a{text-decoration:none;display:block;color:#ffffff}
#nav .away a:hover,.away a:active{text-decoration:underline}
#hidemenu{visibility:hidden;display:none;overflow:hidden;position:fixed;top:0;left:0;height:100%;width:100%}
.main{padding:5px}
.main{background-color:#ffffff}
.pagetitle{font-size:1.4em;font-weight:bold}
@media only screen and (min-width:512px) {
.navtop{padding-top:5px}
#headline{top:0;margin:0;width:160px;height:100%;position:fixed;overflow:auto}
#headline .noselect{display:none}
#headline #nav{visibility:visible;display:block;width:auto;height:auto}
.main{margin-left:170px}
#headline #hidemenu{visibility:hidden}
}
@media not screen and (min-width:512px) {
#headline .noselect{-webkit-user-select:none;-ms-user-select:none;user-select:none;}
#headline #nav #navbot{visibility:hidden;position:fixed;top:0;left:-70%;z-index:2;transition:0.2s;margin:0;padding:0}
#headline input:checked ~ #nav #navbot{height:100%;position:fixed;top:0;left:0;visibility:visible;display:block;box-sizing:border-box;-moz-box-sizing:border-box;-webkit-box-sizing:border-box;vertical-align:center;font-size:1.0em;width:70%;overflow:auto}
#headline input:checked ~ #hidemenu{visibility:visible;display:block;background:black;opacity:0.3;z-index:1}
}
</style>
<title>
HOLTrace: Install</title>
</head>
<body>
<label id=headline>
<input type=checkbox />
<nav id=nav>
<div class=navtop>
<span class=noselect>≡</span>
HOLTrace</div>
<ul id=navbot>
<li class=away><a href=index.html>Intro</a>
</li><li class=away><a href=download.html>Download</a>
</li><li class=here>Install
</li><li class=away><a href=test.html>Test</a>
</li><li class=away><a href=save.html>Save</a>
</li><li class=away><a href=prune.html>Prune</a>
</li><li class=away><a href=verify.html>Verify</a>
</li><li class=away><a href=tex.html>TeX</a>
</li><li class=away><a href=ml.html>ML REPL</a>
</li><li class=away><a href=prooftrace.html>ProofTrace</a>
</li><li class=away><a href=opentheory.html>OpenTheory</a>
</li><li class=away><a href=format.html>Format</a>
</li><li class=away><a href=license.html>License</a>
</li><li class=away><a href=bib.html>Literature</a>
</li></ul></nav>
<div id=hidemenu></div>
</label>
<div class=main>
<div class=pagetitle>HOLTrace: Install</div>
<p>Installation of HOLTrace is designed to allow normal HOL Light usage,
while adding options to HOL Light to
<a href="save.html">save</a>
and
<a href="verify.html">verify</a>
traces.
HOLTrace also includes separate command-line tools (written in C, C++, and Python) to handle traces;
currently these tools are usable only in the <code>holtrace-*</code> package directory.</p>
<h2>Prerequisites</h2>
<p>The instructions below
have been tested on a server named <code>rome1</code> running Debian 11
with the <code>build-essential</code>, <code>opam</code>, <code>python3</code>, <code>pypy3</code>, <code>texlive-xetex</code>, and <code>xdot</code> packages installed,
in a user account that ran</p>
<pre><code>time opam init github git+https://github.com/ocaml/opam-repository.git --disable-sandboxing -a
time opam switch create 5.2.0
time opam install 'hol_light=3.1.0' -y
eval `opam env`
</code></pre>
<p>to install HOL Light 3.1.0 with the OCaml 5.2 bytecode compiler.</p>
<p>The server has two AMD EPYC 7742 CPUs,
but timings reported in this documentation
use only one core (except for <code>holtrace2tex</code>).
Overclocking on the server has been (manually) disabled,
so the CPUs run at 2.245GHz.</p>
<h2>HOLTrace installation</h2>
<p>Make sure you are in the <code>holtrace-*</code> package directory.</p>
<p>Run <code>make -j8</code> to compile the C/C++ tools.</p>
<p>Modify the HOL Light installation to include (1) <code>holtrace.ml</code>
and (2) a <code>hashtt</code> patch to precompute hashes of types, terms, and theorems:</p>
<pre><code>./install+hashtt
</code></pre>
<p>Now <a href="test.html">test</a> the installation.</p>
<h2>Alternative installations</h2>
<p>Instead of <code>./install+hashtt</code>,
you can run <code>./install</code> to install just <code>holtrace.ml</code> without the <code>hashtt</code> patch.
Reasons to use <code>./install</code> rather than <code>./install+hashtt</code>:</p>
<ul>
<li>
<p>Compared to normal HOL Light and to <code>./install</code>,
<code>./install+hashtt</code> increases CPU time for normal usage.
The increase is typically between 10% and 30%.</p>
</li>
<li>
<p><code>./install</code> is less invasive than <code>./install+hashtt</code>
and has a lower risk of bugs.</p>
</li>
</ul>
<p>Reasons to use <code>./install+hashtt</code> rather than <code>./install</code>:</p>
<ul>
<li><code>./install+hashtt</code> is much faster for saving traces than <code>./install</code> is.</li>
</ul>
<p>You can run <code>./uninstall</code> to undo <code>./install+hashtt</code> or to undo <code>./install</code>.
If you want to switch between <code>./install+hashtt</code> and <code>./install</code>,
you don't have to run <code>./uninstall</code> in between.
Instead of switching an installation back and forth,
you can set up one account using <code>./install+hashtt</code> for saving traces,
and another account using <code>./install</code> for regular use (including replaying traces).</p><hr><font size=1><b>Version:</b>
This is version 2025.06.30 of the "Install" web page.
</font>
</div>
</body>
</html>