installation.html

<?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>
<!-- 2024-06-21 Fri 16:11 -->
<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="generator" content="Org mode" />
<meta name="author" content="Reynald Affeldt" />
<style type="text/css">
 <!--/*--><![CDATA[/*><!--*/
  .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 #ccc;
    box-shadow: 3px 3px 3px #eee;
    padding: 8pt;
    font-family: monospace;
    overflow: auto;
    margin: 1.2em;
  }
  pre.src {
    position: relative;
    overflow: visible;
    padding-top: 1.2em;
  }
  pre.src:before {
    display: none;
    position: absolute;
    background-color: white;
    top: -10px;
    right: 10px;
    padding: 3px;
    border: 1px solid black;
  }
  pre.src:hover:before { display: inline;}
  /* Languages per Org manual */
  pre.src-asymptote:before { content: 'Asymptote'; }
  pre.src-awk:before { content: 'Awk'; }
  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 { width: 90%; }
  /*]]>*/-->
</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>
<script type="text/javascript">
/*
@licstart  The following is the entire license notice for the
JavaScript code in this tag.

Copyright (C) 2012-2020 Free Software Foundation, Inc.

The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version.  The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.

As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.


@licend  The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
 function CodeHighlightOn(elem, id)
 {
   var target = document.getElementById(id);
   if(null != target) {
     elem.cacheClassElem = elem.className;
     elem.cacheClassTarget = target.className;
     target.className = "code-highlighted";
     elem.className   = "code-highlighted";
   }
 }
 function CodeHighlightOff(elem, id)
 {
   var target = document.getElementById(id);
   if(elem.cacheClassElem)
     elem.className = elem.cacheClassElem;
   if(elem.cacheClassTarget)
     target.className = elem.cacheClassTarget;
 }
/*]]>*///-->
</script>
</head>
<body>
<div id="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 <a href="https://coq.inria.fr/">Coq</a> is
implemented.
</p>

<p>
The relevant packages can be found in the <a href="https://coq.inria.fr/opam/www/">Coq package index</a>;
their name is usually prefixed with <code>coq-mathcomp-</code>.
</p>

<div id="outline-container-org170a151" class="outline-2">
<h2 id="org170a151">Install the Base Mathematical Components Libraries</h2>
<div class="outline-text-2" id="text-org170a151">
</div>
<div id="outline-container-org27c9923" class="outline-3">
<h3 id="org27c9923">Installation using the <a href="https://opam.ocaml.org/">opam</a> package manager</h3>
<div class="outline-text-3" id="text-org27c9923">
<ul class="org-ul">
<li>Using opam, the installation of the base Mathematical Components
library is as simple as this:</li>
</ul>

<pre class="example">
opam repo add coq-released https://coq.inria.fr/opam/released
opam install coq-mathcomp-ssreflect
</pre>

<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-org4fadafc" class="outline-3">
<h3 id="org4fadafc">Installation using the <a href="https://github.com/coq/platform">Coq platform</a></h3>
<div class="outline-text-3" id="text-org4fadafc">
<ul class="org-ul">
<li>The <a href="https://github.com/coq/platform">Coq platform</a> is a distribution of <a href="https://coq.inria.fr/">Coq</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-org7e04d4a" class="outline-3">
<h3 id="org7e04d4a">Other installation instructions and details</h3>
<div class="outline-text-3" id="text-org7e04d4a">
<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-orgde346cd" class="outline-2">
<h2 id="orgde346cd">Install Other Mathematical Components Libraries</h2>
<div class="outline-text-2" id="text-orgde346cd">
<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://github.com/coq-community">coq-community</a> also features a number of libraries using Mathematical Components.</li>
</ul>
</div>
</div>
</div>
</body>
</html>