<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/numbat @ v1.8.0</title>
<meta name="description" content="README.md in fork/numbat at v1.8.0.">
<meta property="og:title" content="README.md - fork/numbat @ v1.8.0">
<meta property="og:description" content="README.md in fork/numbat at v1.8.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="v1.8.0" data-tip="c04afb354608ef22e475d8d6fec955ca6e823d97">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/numbat</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/numbat</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">David Peter</span><span class="commit-message" data-commit="f7bf1ee38290ae1042187bb465f38cb0ac811497">Fix README links</span><span class="snapshot-sha sha" data-commit="f7bf1ee38290ae1042187bb465f38cb0ac811497">f7bf1ee</span><time datetime="2023-11-03T19:41:42+01:00" title="2023-11-03 19:41:42 +0100">2023-11-03</time></p>
<header class="topbar"><details class="switcher"><summary>v1.8.0</summary><div class="menu"><strong>branches</strong><a href="/fork/numbat/ref/master/">master</a><strong>tags</strong><a href="/fork/numbat/ref/v1.6.0/">v1.6.0</a><a href="/fork/numbat/ref/v1.6.1/">v1.6.1</a><a href="/fork/numbat/ref/v1.6.2/">v1.6.2</a><a href="/fork/numbat/ref/v1.6.3/">v1.6.3</a><a href="/fork/numbat/ref/v1.7.0/">v1.7.0</a><a class="current" href="/fork/numbat/ref/v1.8.0/">v1.8.0</a><a class="all" href="/fork/numbat/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/numbat/">numbat</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>6.3 KiB</span><span>175 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/4f9e87e5f779e6360c54ff8048f4cf1ecdf0dd08/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;div align="center"&gt;
&lt;img src="numbat-wasm/www/numbat.svg"&gt;
<p><strong><a href="https://numbat.dev/">Try online!</a> • <a href="https://numbat.dev/doc/">Documentation</a> • <a href="https://numbat.dev/doc/tutorial.html">Tutorial</a> • <a href="https://numbat.dev/doc/example-numbat_syntax.html">Syntax reference</a> • <a href="https://numbat.dev/doc/cli-installation.html">Installation</a> • <a href="#development">Development</a></strong></p>
<p><em>Numbat</em> is a statically typed programming language for scientific computations&lt;br&gt;
with first class support for physical dimensions and units.</p>
&lt;/div&gt;
<h2>Key Features</h2>
&lt;img src="assets/numbat-interactive.png" align="right"&gt;
<p><em>Click to learn more.</em></p>
&lt;details&gt;
&lt;summary&gt;
&lt;b&gt;Physical dimensions as types&lt;/b&gt;
&lt;/summary&gt;
&lt;p&gt;&lt;/p&gt;
<p>Numbat has a static type system where physical dimensions like <code>Length</code> and <code>Time</code> act as types.
Definitions of constants and functions can optionally contain type annotations that will be statically enforced.
If the types are not specified, they will be inferred (<code>Speed</code>, <code>Money</code> and <code>Frequency</code> in the screenshot).</p>
<p>See <a href="https://numbat.dev/doc/type-system.html">this article</a> to learn more about Numbat's type system.</p>
&lt;/details&gt;
&lt;details&gt;
&lt;summary&gt;
&lt;b&gt;First-class physical units&lt;/b&gt;
&lt;/summary&gt;
&lt;p&gt;&lt;/p&gt;
<p>Numbat is focused on computations with units. Units are therefore treated as first-class citizens. They can be
<a href="https://numbat.dev/doc/unit-notation.html">entered in various ways</a> (<code>km/h</code> or <code>kilometer/hour</code>, <code>GiB</code> or
<code>gibibytes</code>, <code>°</code> or <code>degree</code>, <code>m²</code> or <code>m^2</code>).
New units can be <a href="https://numbat.dev/doc/unit-definitions.html">introduced</a> on the spot (<code>unit pixel</code>).
Compatible units can be converted easily <a href="https://numbat.dev/doc/unit-conversions.html">using the <code>-&gt;</code> operator</a> (<code>30 km/h -&gt; mph</code>, <code>1 mrad -&gt; degree</code>, <code>5 in + 2 ft -&gt; cm</code>, <code>27 weeks -&gt; days</code>).
And unit expressions are simplified using various heuristics (<code>15 km/h * 30 min = 7.5 km</code>).</p>
&lt;/details&gt;
&lt;details&gt;
&lt;summary&gt;
&lt;b&gt;Comprehensive standard library&lt;/b&gt;
&lt;/summary&gt;
&lt;p&gt;&lt;/p&gt;
<p>Numbat's <a href="https://numbat.dev/doc/prelude.html">standard library</a> comes with a large number of physical dimensions and units (SI, US Customary, Imperial, Nautical, Astronomical, Atomic, Nuclear, …).
See <a href="https://numbat.dev/doc/list-units.html">this reference page</a> for a complete overview.
It also contains a lot of <a href="https://numbat.dev/doc/list-constants.html">mathematical and physical constants</a>
as well as a large range of <a href="https://numbat.dev/doc/list-functions.html">pre-defined functions</a>.</p>
&lt;/details&gt;
&lt;details&gt;
&lt;summary&gt;
&lt;b&gt;Strict syntax&lt;/b&gt;
&lt;/summary&gt;
&lt;p&gt;&lt;/p&gt;
<p>Numbat's parser never tries to be "smart" on syntactically incorrect input.
This means you will either get a (descriptive) error message, or you can trust the result of your calculation.</p>
&lt;/details&gt;
&lt;details&gt;
&lt;summary&gt;
&lt;b&gt;Excellent error messages&lt;/b&gt;
&lt;/summary&gt;
&lt;p&gt;&lt;/p&gt;
<p>Numbat aims to provide <a href="https://github.com/sharkdp/numbat/blob/master/assets/numbat-error.png">descriptive and helpful error messages</a>.</p>
&lt;/details&gt;
&lt;details&gt;
&lt;summary&gt;
&lt;b&gt;Interactive terminal&lt;/b&gt;
&lt;/summary&gt;
&lt;p&gt;&lt;/p&gt;
<p>Numbat has been designed for an interactive use-case with small "one off" computations. Opening the <code>numbat</code> interpreter
without any arguments starts a <a href="https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop">REPL</a> with a familiar
readline interface, including all the usual features like a command history, Ctrl-R search or tab completion.</p>
&lt;/details&gt;
&lt;details&gt;
&lt;summary&gt;
&lt;b&gt;Modular and customizable&lt;/b&gt;
&lt;/summary&gt;
&lt;p&gt;&lt;/p&gt;
<p>The whole system of physical dimensions and units is specified Numbat's standard library, which is
<a href="https://github.com/sharkdp/numbat/tree/master/numbat/modules">written in the Numbat language</a> itself. It is therefore
easily extensible by <a href="https://numbat.dev/doc/cli-customization.html">providing a <code>init.nbt</code> file</a>. For example,
a single line (<code>unit bathtub = 150 L</code>) is usually enough to add a new unit. Users can even choose to write their
own <code>prelude</code> module, allowing for arbitrary modifications to the unit system.</p>
&lt;/details&gt;
&lt;details&gt;
&lt;summary&gt;
&lt;b&gt;Assertions&lt;/b&gt;
&lt;/summary&gt;
&lt;p&gt;&lt;/p&gt;
<p>With its static type system, Numbat already enforces correctness of your calculations on a physical dimension level.
But some checks can only be made at runtime. Numbat provides an <code>assert_eq</code> procedure that allows you to check for
exact equality using <code>assert_eq(12 ft, 1 in)</code> or approximate equality using <code>assert_eq(c, 300_000 km/s, 1% × c)</code>.
This can be useful to make sure that intermediate results do not change during a restructuring of your calculation.</p>
&lt;/details&gt;
&lt;details&gt;
&lt;summary&gt;
&lt;b&gt;Non-features&lt;/b&gt;
&lt;/summary&gt;
&lt;p&gt;&lt;/p&gt;
<p>Numbat is a scientific calculator. It's not a computer algebra system that solves differential equations
or computes intergrals. Try <a href="http://www.wolframalpha.com/">WolframAlpha</a> instead.&lt;br&gt;
There is no graphical user interface with buttons like <code>x²</code>, <code>1/x</code> or <code>DEG/RAD</code>.
<a href="http://qalculate.github.io/">Qalculate!</a> is a fantastic tool that supports both text as well as graphical
input.&lt;br&gt;
Numbat supports a huge range of physical units. If you need something even more comprehensive,
please consider contributing. Or try <a href="https://www.gnu.org/software/units/">GNU units</a>.</p>
&lt;/details&gt;
&lt;p&gt;&amp;nbsp;&lt;/p&gt;
&lt;p&gt;&amp;nbsp;&lt;/p&gt;
&lt;p&gt;&amp;nbsp;&lt;/p&gt;
&lt;p&gt;&amp;nbsp;&lt;/p&gt;
<h2>Installation</h2>
<p>See <a href="https://numbat.dev/doc/cli-installation.html">this page</a> for details on how to install the native command-line version of Numbat.</p>
<h2>Development</h2>
<p>Run Numbat CLI</p>
<pre>cargo run -- &lt;numbat args&gt;
</pre>
<p>Install the CLI version</p>
<pre>cargo install -f --path numbat-cli
</pre>
<p>Run all tests</p>
<pre>cargo test
</pre>
<h3>Working on the <code>prelude</code></h3>
<p>If you are working on <a href="/fork/numbat/ref/v1.8.0/tree/numbat/modules/">Numbat's standard library</a>, it is convenient to point
the <code>NUMBAT_MODULES_PATH</code> environment variable to the <code>numbat/modules/</code> folder. This way,
you don't have to recompile Numbat to see your changes.</p>
<p>Alternatively, you can create a symlink from <code>~/.config/numbat/modules</code> to the <code>numbat/modules/</code>
folder in the repository (see <a href="https://numbat.dev/doc/cli-customization.html#module-paths">this page</a>
for the standard paths on other operating systems).</p>
<h2>Contact us</h2>
<p>To contact us, either <a href="https://github.com/sharkdp/numbat/issues/new/choose">open a GitHub issue</a>
or <a href="https://github.com/sharkdp/numbat/discussions">discussion</a>, or pop into <code>#numbat</code> on
<a href="https://libera.chat">Libera.Chat</a> (<a href="https://web.libera.chat/gamja/#numbat">link to webchat</a>).</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>&lt;</a-p><a-tg>div</a-tg> <a-at>align</a-at>=&quot;<a-s>center</a-s>&quot;<a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>&lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>numbat-wasm/www/numbat.svg</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>**[Try online!] • [Documentation] • [Tutorial] • [Syntax reference] • [Installation] • [Development]**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-tu>[Try online!]</a-tu><a-p>: </a-p><a-tu>https://numbat.dev/</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-tu>[Features]</a-tu><a-p>: </a-p><a-tu>#key-features</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-tu>[Documentation]</a-tu><a-p>: </a-p><a-tu>https://numbat.dev/doc/</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-tu>[Tutorial]</a-tu><a-p>: </a-p><a-tu>https://numbat.dev/doc/tutorial.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-tu>[Syntax reference]</a-tu><a-p>: </a-p><a-tu>https://numbat.dev/doc/example-numbat_syntax.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-tu>[Installation]</a-tu><a-p>: </a-p><a-tu>https://numbat.dev/doc/cli-installation.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-tu>[Development]</a-tu><a-p>: </a-p><a-tu>#development</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>*Numbat* is a statically typed programming language for scientific computations&lt;br&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>with first class support for physical dimensions and units.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>&lt;/div&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>## </a-p><a-tt>Key Features</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>&lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>assets/numbat-interactive.png</a-s><a-p>&quot; </a-p><a-at>align</a-at><a-p>=&quot;</a-p><a-s>right</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>*Click to learn more.*</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>&lt;</a-p><a-tg>details</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>&lt;</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>&lt;</a-p><a-tg>b</a-tg><a-p>&gt;Physical dimensions as types&lt;/</a-p><a-tg>b</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>Numbat has a static type system where physical dimensions like `Length` and `Time` act as types.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>Definitions of constants and functions can optionally contain type annotations that will be statically enforced.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>If the types are not specified, they will be inferred (`Speed`, `Money` and `Frequency` in the screenshot).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>See [this article](https://numbat.dev/doc/type-system.html) to learn more about Numbat&#39;s type system.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>&lt;/details&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>&lt;</a-p><a-tg>details</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>&lt;</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>&lt;</a-p><a-tg>b</a-tg><a-p>&gt;First-class physical units&lt;/</a-p><a-tg>b</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>Numbat is focused on computations with units. Units are therefore treated as first-class citizens. They can be</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>[entered in various ways](https://numbat.dev/doc/unit-notation.html) (`km/h` or `kilometer/hour`, `GiB` or</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>`gibibytes`, `°` or `degree`, `m²` or `m^2`).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>New units can be [introduced](https://numbat.dev/doc/unit-definitions.html) on the spot (`unit pixel`).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>Compatible units can be converted easily [using the `-&gt;` operator](https://numbat.dev/doc/unit-conversions.html) (`30 km/h -&gt; mph`, `1 mrad -&gt; degree`, `5 in + 2 ft -&gt; cm`, `27 weeks -&gt; days`).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>And unit expressions are simplified using various heuristics (`15 km/h * 30 min = 7.5 km`).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>&lt;/details&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>&lt;</a-p><a-tg>details</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>&lt;</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>&lt;</a-p><a-tg>b</a-tg><a-p>&gt;Comprehensive standard library&lt;/</a-p><a-tg>b</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>Numbat&#39;s [standard library](https://numbat.dev/doc/prelude.html) comes with a large number of physical dimensions and units (SI, US Customary, Imperial, Nautical, Astronomical, Atomic, Nuclear, …).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>See [this reference page](https://numbat.dev/doc/list-units.html) for a complete overview.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>It also contains a lot of [mathematical and physical constants](https://numbat.dev/doc/list-constants.html)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>as well as a large range of [pre-defined functions](https://numbat.dev/doc/list-functions.html).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>&lt;/details&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>&lt;</a-p><a-tg>details</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>&lt;</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>&lt;</a-p><a-tg>b</a-tg><a-p>&gt;Strict syntax&lt;/</a-p><a-tg>b</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>Numbat&#39;s parser never tries to be &quot;smart&quot; on syntactically incorrect input.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>This means you will either get a (descriptive) error message, or you can trust the result of your calculation.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>&lt;/details&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>&lt;</a-p><a-tg>details</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>&lt;</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>&lt;</a-p><a-tg>b</a-tg><a-p>&gt;Excellent error messages&lt;/</a-p><a-tg>b</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>Numbat aims to provide [descriptive and helpful error messages](https://github.com/sharkdp/numbat/blob/master/assets/numbat-error.png).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>&lt;/details&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>&lt;</a-p><a-tg>details</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>&lt;</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>&lt;</a-p><a-tg>b</a-tg><a-p>&gt;Interactive terminal&lt;/</a-p><a-tg>b</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>Numbat has been designed for an interactive use-case with small &quot;one off&quot; computations. Opening the `numbat` interpreter</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>without any arguments starts a [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) with a familiar</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>readline interface, including all the usual features like a command history, Ctrl-R search or tab completion.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>&lt;/details&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>&lt;</a-p><a-tg>details</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>&lt;</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>&lt;</a-p><a-tg>b</a-tg><a-p>&gt;Modular and customizable&lt;/</a-p><a-tg>b</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>The whole system of physical dimensions and units is specified Numbat&#39;s standard library, which is</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>[written in the Numbat language](https://github.com/sharkdp/numbat/tree/master/numbat/modules) itself. It is therefore</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>easily extensible by [providing a `init.nbt` file](https://numbat.dev/doc/cli-customization.html). For example,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>a single line (`unit bathtub = 150 L`) is usually enough to add a new unit. Users can even choose to write their</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>own `prelude` module, allowing for arbitrary modifications to the unit system.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>&lt;/details&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>&lt;</a-p><a-tg>details</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>&lt;</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>&lt;</a-p><a-tg>b</a-tg><a-p>&gt;Assertions&lt;/</a-p><a-tg>b</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>With its static type system, Numbat already enforces correctness of your calculations on a physical dimension level.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>But some checks can only be made at runtime. Numbat provides an `assert_eq` procedure that allows you to check for</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>exact equality using `assert_eq(12 ft, 1 in)` or approximate equality using `assert_eq(c, 300_000 km/s, 1% × c)`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>This can be useful to make sure that intermediate results do not change during a restructuring of your calculation.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>&lt;/details&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>&lt;</a-p><a-tg>details</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p>&lt;</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p>&lt;</a-p><a-tg>b</a-tg><a-p>&gt;Non-features&lt;/</a-p><a-tg>b</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>summary</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p>Numbat is a scientific calculator. It&#39;s not a computer algebra system that solves differential equations</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>or computes intergrals. Try [WolframAlpha](http://www.wolframalpha.com/) instead.&lt;br&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>There is no graphical user interface with buttons like `x²`, `1/x` or `DEG/RAD`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p>[Qalculate!](http://qalculate.github.io/) is a fantastic tool that supports both text as well as graphical</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"><a-p>input.&lt;br&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>Numbat supports a huge range of physical units. If you need something even more comprehensive,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"><a-p>please consider contributing. Or try [GNU units](https://www.gnu.org/software/units/).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>&lt;/details&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&amp;nbsp;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&amp;nbsp;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&amp;nbsp;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"><a-p>&lt;</a-p><a-tg>p</a-tg><a-p>&gt;&amp;nbsp;&lt;/</a-p><a-tg>p</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"><a-p>## </a-p><a-tt>Installation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"><a-p>See [this page](https://numbat.dev/doc/cli-installation.html) for details on how to install the native command-line version of Numbat.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p>## </a-p><a-tt>Development</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p>Run Numbat CLI</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"><a-p>cargo run -- &lt;numbat args&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"><a-p>Install the CLI version</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"><a-p>cargo install -f --path numbat-cli</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"><a-p>Run all tests</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"><a-p>cargo test</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"><a-p>### </a-p><a-tt>Working on the `prelude`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"><a-p>If you are working on [Numbat&#39;s standard library](numbat/modules/), it is convenient to point</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"><a-p>the `NUMBAT_MODULES_PATH` environment variable to the `numbat/modules/` folder. This way,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"><a-p>you don&#39;t have to recompile Numbat to see your changes.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"><a-p>Alternatively, you can create a symlink from `~/.config/numbat/modules` to the `numbat/modules/`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"><a-p>folder in the repository (see [this page](https://numbat.dev/doc/cli-customization.html#module-paths)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p>for the standard paths on other operating systems).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><a-p>## </a-p><a-tt>Contact us</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text">To contact us, either [open a GitHub issue](https://github.com/sharkdp/numbat/issues/new/choose)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text">or [discussion](https://github.com/sharkdp/numbat/discussions), or pop into `#numbat` on</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text">[Libera.Chat](https://libera.chat) ([link to webchat](https://web.libera.chat/gamja/#numbat)).</span></span></pre></div></div>
</main>
</body>
</html>
