math-comp.github.io/installation.html at master · math-comp/math-comp.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2025-11-13 Thu 11:07 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Mathematical Components: Installation</title>
<meta name="author" content="Reynald Affeldt" />
<meta name="generator" content="Org Mode" />
<style type="text/css">
  #content { max-width: 60em; margin: auto; }
  .title  { text-align: center;
             margin-bottom: .2em; }
  .subtitle { text-align: center;
              font-size: medium;
              font-weight: bold;
              margin-top:0; }
  .todo   { font-family: monospace; color: red; }
  .done   { font-family: monospace; color: green; }
  .priority { font-family: monospace; color: orange; }
  .tag    { background-color: #eee; font-family: monospace;
            padding: 2px; font-size: 80%; font-weight: normal; }
  .timestamp { color: #bebebe; }
  .timestamp-kwd { color: #5f9ea0; }
  .org-right  { margin-left: auto; margin-right: 0px;  text-align: right; }
  .org-left   { margin-left: 0px;  margin-right: auto; text-align: left; }
  .org-center { margin-left: auto; margin-right: auto; text-align: center; }
  .underline { text-decoration: underline; }
  #postamble p, #preamble p { font-size: 90%; margin: .2em; }
  p.verse { margin-left: 3%; }
  pre {
    border: 1px solid #e6e6e6;
    border-radius: 3px;
    background-color: #f2f2f2;
    padding: 8pt;
    font-family: monospace;
    overflow: auto;
    margin: 1.2em;
  }
  pre.src {
    position: relative;
    overflow: auto;
  }
  pre.src:before {
    display: none;
    position: absolute;
    top: -8px;
    right: 12px;
    padding: 3px;
    color: #555;
    background-color: #f2f2f299;
  }
  pre.src:hover:before { display: inline; margin-top: 14px;}
  /* Languages per Org manual */
  pre.src-asymptote:before { content: 'Asymptote'; }
  pre.src-awk:before { content: 'Awk'; }
  pre.src-authinfo::before { content: 'Authinfo'; }
  pre.src-C:before { content: 'C'; }
  /* pre.src-C++ doesn't work in CSS */
  pre.src-clojure:before { content: 'Clojure'; }
  pre.src-css:before { content: 'CSS'; }
  pre.src-D:before { content: 'D'; }
  pre.src-ditaa:before { content: 'ditaa'; }
  pre.src-dot:before { content: 'Graphviz'; }
  pre.src-calc:before { content: 'Emacs Calc'; }
  pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
  pre.src-fortran:before { content: 'Fortran'; }
  pre.src-gnuplot:before { content: 'gnuplot'; }
  pre.src-haskell:before { content: 'Haskell'; }
  pre.src-hledger:before { content: 'hledger'; }
  pre.src-java:before { content: 'Java'; }
  pre.src-js:before { content: 'Javascript'; }
  pre.src-latex:before { content: 'LaTeX'; }
  pre.src-ledger:before { content: 'Ledger'; }
  pre.src-lisp:before { content: 'Lisp'; }
  pre.src-lilypond:before { content: 'Lilypond'; }
  pre.src-lua:before { content: 'Lua'; }
  pre.src-matlab:before { content: 'MATLAB'; }
  pre.src-mscgen:before { content: 'Mscgen'; }
  pre.src-ocaml:before { content: 'Objective Caml'; }
  pre.src-octave:before { content: 'Octave'; }
  pre.src-org:before { content: 'Org mode'; }
  pre.src-oz:before { content: 'OZ'; }
  pre.src-plantuml:before { content: 'Plantuml'; }
  pre.src-processing:before { content: 'Processing.js'; }
  pre.src-python:before { content: 'Python'; }
  pre.src-R:before { content: 'R'; }
  pre.src-ruby:before { content: 'Ruby'; }
  pre.src-sass:before { content: 'Sass'; }
  pre.src-scheme:before { content: 'Scheme'; }
  pre.src-screen:before { content: 'Gnu Screen'; }
  pre.src-sed:before { content: 'Sed'; }
  pre.src-sh:before { content: 'shell'; }
  pre.src-sql:before { content: 'SQL'; }
  pre.src-sqlite:before { content: 'SQLite'; }
  /* additional languages in org.el's org-babel-load-languages alist */
  pre.src-forth:before { content: 'Forth'; }
  pre.src-io:before { content: 'IO'; }
  pre.src-J:before { content: 'J'; }
  pre.src-makefile:before { content: 'Makefile'; }
  pre.src-maxima:before { content: 'Maxima'; }
  pre.src-perl:before { content: 'Perl'; }
  pre.src-picolisp:before { content: 'Pico Lisp'; }
  pre.src-scala:before { content: 'Scala'; }
  pre.src-shell:before { content: 'Shell Script'; }
  pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
  /* additional language identifiers per "defun org-babel-execute"
       in ob-*.el */
  pre.src-cpp:before  { content: 'C++'; }
  pre.src-abc:before  { content: 'ABC'; }
  pre.src-coq:before  { content: 'Coq'; }
  pre.src-groovy:before  { content: 'Groovy'; }
  /* additional language identifiers from org-babel-shell-names in
     ob-shell.el: ob-shell is the only babel language using a lambda to put
     the execution function name together. */
  pre.src-bash:before  { content: 'bash'; }
  pre.src-csh:before  { content: 'csh'; }
  pre.src-ash:before  { content: 'ash'; }
  pre.src-dash:before  { content: 'dash'; }
  pre.src-ksh:before  { content: 'ksh'; }
  pre.src-mksh:before  { content: 'mksh'; }
  pre.src-posh:before  { content: 'posh'; }
  /* Additional Emacs modes also supported by the LaTeX listings package */
  pre.src-ada:before { content: 'Ada'; }
  pre.src-asm:before { content: 'Assembler'; }
  pre.src-caml:before { content: 'Caml'; }
  pre.src-delphi:before { content: 'Delphi'; }
  pre.src-html:before { content: 'HTML'; }
  pre.src-idl:before { content: 'IDL'; }
  pre.src-mercury:before { content: 'Mercury'; }
  pre.src-metapost:before { content: 'MetaPost'; }
  pre.src-modula-2:before { content: 'Modula-2'; }
  pre.src-pascal:before { content: 'Pascal'; }
  pre.src-ps:before { content: 'PostScript'; }
  pre.src-prolog:before { content: 'Prolog'; }
  pre.src-simula:before { content: 'Simula'; }
  pre.src-tcl:before { content: 'tcl'; }
  pre.src-tex:before { content: 'TeX'; }
  pre.src-plain-tex:before { content: 'Plain TeX'; }
  pre.src-verilog:before { content: 'Verilog'; }
  pre.src-vhdl:before { content: 'VHDL'; }
  pre.src-xml:before { content: 'XML'; }
  pre.src-nxml:before { content: 'XML'; }
  /* add a generic configuration mode; LaTeX export needs an additional
     (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
  pre.src-conf:before { content: 'Configuration File'; }

  table { border-collapse:collapse; }
  caption.t-above { caption-side: top; }
  caption.t-bottom { caption-side: bottom; }
  td, th { vertical-align:top;  }
  th.org-right  { text-align: center;  }
  th.org-left   { text-align: center;   }
  th.org-center { text-align: center; }
  td.org-right  { text-align: right;  }
  td.org-left   { text-align: left;   }
  td.org-center { text-align: center; }
  dt { font-weight: bold; }
  .footpara { display: inline; }
  .footdef  { margin-bottom: 1em; }
  .figure { padding: 1em; }
  .figure p { text-align: center; }
  .equation-container {
    display: table;
    text-align: center;
    width: 100%;
  }
  .equation {
    vertical-align: middle;
  }
  .equation-label {
    display: table-cell;
    text-align: right;
    vertical-align: middle;
  }
  .inlinetask {
    padding: 10px;
    border: 2px solid gray;
    margin: 10px;
    background: #ffffcc;
  }
  #org-div-home-and-up
   { text-align: right; font-size: 70%; white-space: nowrap; }
  textarea { overflow-x: auto; }
  .linenr { font-size: smaller }
  .code-highlighted { background-color: #ffff00; }
  .org-info-js_info-navigation { border-style: none; }
  #org-info-js_console-label
    { font-size: 10px; font-weight: bold; white-space: nowrap; }
  .org-info-js_search-highlight
    { background-color: #ffff00; color: #000000; font-weight: bold; }
  .org-svg { }
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css"> body {font-family: Arial, Helvetica; margin-left: 5em; font-size: large;} </style>
<style type="text/css"> h1 {margin-left: 0em; padding: 0px; text-align: center} </style>
<style type="text/css"> h2 {margin-left: 0em; padding: 0px; color: #580909} </style>
<style type="text/css"> h3 {margin-left: 1em; padding: 0px; color: #C05001;} </style>
<style type="text/css"> body { max-width: 1100px; width: 100% - 30px; margin-left: 30px; }</style>
</head>
<body>
<div id="content" class="content">
<h1 class="title">Mathematical Components: Installation</h1>
<p>
The Mathematical Components libraries are provided as separate packages:
</p>

<ul class="org-ul">
<li>The base libraries are the libraries that support the formalization
of the Four Color Theorem and of the Odd Order Theorem.</li>

<li>Other libraries contain extensions and applications.</li>
</ul>

<p>
The installation of Mathematical Components is best done using <a href="https://opam.ocaml.org/">opam</a>, a
package manager for <a href="https://ocaml.org/">OCaml</a>, the programming language with which the
<a href="https://rocq-prover.org/">Rocq</a> prover is implemented.
</p>

<p>
The relevant packages can be found in the <a href="https://rocq-prover.org/packages">Rocq package index</a>;
their name is usually prefixed with <code>rocq-mathcomp-</code> or <code>coq-mathcomp-</code>.
</p>
<div id="outline-container-org3ac722b" class="outline-2">
<h2 id="org3ac722b">Install the Base Mathematical Components Libraries</h2>
<div class="outline-text-2" id="text-org3ac722b">
</div>
<div id="outline-container-org550b021" class="outline-3">
<h3 id="org550b021">Installation using the <a href="https://opam.ocaml.org/">opam</a> package manager</h3>
<div class="outline-text-3" id="text-org550b021">
<ul class="org-ul">
<li>Using opam, the installation of the base Mathematical Components
library is as simple as this:</li>
</ul>

<div class="org-src-container">
<pre class="src src-nil">opam repo add coq-released https://coq.inria.fr/opam/released
opam install coq-mathcomp-ssreflect
</pre>
</div>

<ul class="org-ul">
<li>Other base mathematical components libraries can then be installed
similarly using <code>opam install</code>:
<ul class="org-ul">
<li><code>coq-mathcomp-algebra</code>,</li>
<li><code>coq-mathcomp-field</code>,</li>
<li><code>coq-mathcomp-solvable</code>,</li>
<li><code>coq-mathcomp-fingroup</code>,</li>
<li><code>coq-mathcomp-character</code>.</li>
</ul></li>
</ul>
</div>
</div>
<div id="outline-container-orge2a9eef" class="outline-3">
<h3 id="orge2a9eef">Installation using the <a href="https://github.com/rocq-prover/platform">Coq platform</a></h3>
<div class="outline-text-3" id="text-orge2a9eef">
<ul class="org-ul">
<li>The <a href="https://github.com/coq/platform">Coq platform</a> is a distribution of <a href="https://rocq-prover.org/">Rocq</a> together with a selection of libraries
including most Mathematical Components libraries. It supports Linux, macOS, and Windows.</li>
</ul>
</div>
</div>
<div id="outline-container-org352ce28" class="outline-3">
<h3 id="org352ce28">Other installation instructions and details</h3>
<div class="outline-text-3" id="text-org352ce28">
<ul class="org-ul">
<li>You can find more detailed installation instructions in <a href="https://github.com/math-comp/math-comp/blob/master/INSTALL.md">INSTALL.md</a>
(from the official distribution), this includes:
<ul class="org-ul">
<li>various ways of installing using <code>opam</code></li>
<li>installation from the source files (using <code>make</code>)</li>
<li>installation using nix</li>
</ul></li>

<li>Installation instructions in <a href="https://staff.aist.go.jp/reynald.affeldt/ssrcoq/install.html">Japanese, 日本語</a>
<ul class="org-ul">
<li>see「パッケージからの設定」for installation using <code>opam</code></li>
</ul></li>

<li>Advanced: Installation Instructions for Windows 11 using cygwin-opam or WSL
<ul class="org-ul">
<li>It is possible to install the Mathematical Components libraries on
Windows 11 using <a href="https://www.cygwin.com/">cygwin</a> together with the binary distribution of Coq
or together with <a href="https://fdopen.github.io/opam-repository-mingw/installation/">opam for Windows</a>, or with Windows Subsystem for
Linux, as explained for example <a href="https://github.com/affeldt-aist/mathcomp-install/blob/master/install-windows-en.org">here</a>.</li>
</ul></li>
</ul>
</div>
</div>
</div>
<div id="outline-container-org1854027" class="outline-2">
<h2 id="org1854027">Install Other Mathematical Components Libraries</h2>
<div class="outline-text-2" id="text-org1854027">
<p>
There are several libraries that build on top of the base
Mathematical Components libraries, e.g.:
</p>

<p>
Extensions:
</p>

<ol class="org-ol">
<li><a href="https://github.com/math-comp/finmap">Finite sets, finite maps, multisets and generic sets</a>
<ul class="org-ul">
<li>Available as the opam package <code>coq-mathcomp-finmap</code></li>
</ul></li>
<li><a href="https://github.com/math-comp/multinomials">Multinomials for the Mathematical Components library</a>
<ul class="org-ul">
<li>Available as the opam package <code>coq-mathcomp-multinomials</code></li>
</ul></li>
<li><a href="https://github.com/math-comp/real-closed">Theorems for Real Closed Fields</a>
<ul class="org-ul">
<li>Available as the opam package <code>coq-mathcomp-real-closed</code></li>
</ul></li>
<li>A layer for classical reasoning (developed along <a href="https://github.com/math-comp/analysis">MathComp Analysis</a>)
<ul class="org-ul">
<li>Available as the opam package <code>coq-mathcomp-classical</code></li>
</ul></li>
<li><a href="https://github.com/math-comp/analysis">MathComp Analysis</a>
<ul class="org-ul">
<li>Available as the opam package <code>coq-mathcomp-analysis</code></li>
</ul></li>
</ol>

<p>
Applications:
</p>

<ol class="org-ol">
<li><a href="https://github.com/math-comp/fourcolor">The Four Color theorem</a>
<ul class="org-ul">
<li>Available as the opam package <code>coq-fourcolor</code></li>
</ul></li>
<li><a href="https://github.com/math-comp/odd-order">The Odd Order theorem</a>
<ul class="org-ul">
<li>Available as the opam package <code>coq-mathcomp-odd-order</code></li>
</ul></li>
<li><a href="https://github.com/math-comp/Abel">Abel-Ruffini theorem</a>
<ul class="org-ul">
<li>Available as the opam package <code>coq-mathcomp-abel</code></li>
</ul></li>
<li><a href="https://github.com/coq-community/apery">A formal proof of the irrationality of zeta(3), the Apéry constant</a>
<ul class="org-ul">
<li>Available as the opam package <code>coq-mathcomp-apery</code></li>
</ul></li>
</ol>

<p>
More libraries:
</p>
<ul class="org-ul">
<li>See the Mathematical Components' <a href="https://github.com/math-comp">github</a>.</li>
<li><a href="https://rocq-community.org/">rocq-community</a> also features a number of libraries using Mathematical Components.</li>
</ul>
</div>
</div>
</div>
</body>
</html>