<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>book/src/unit-notation.md - fork/numbat @ master</title>
<meta name="description" content="book/src/unit-notation.md in fork/numbat at master.">
<meta property="og:title" content="book/src/unit-notation.md - fork/numbat @ master">
<meta property="og:description" content="book/src/unit-notation.md in fork/numbat at master.">
<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="master" data-tip="b070b880c8a713bac881084034ea6f0d857868ed">
<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="b70f4997ba118b373cfd2cc8ea49636843a5af88">Documentation improvements</span><span class="snapshot-sha sha" data-commit="b70f4997ba118b373cfd2cc8ea49636843a5af88">b70f499</span><time datetime="2023-09-12T20:16:13+02:00" title="2023-09-12 20:16:13 +0200">2023-09-12</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" 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 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> / <a href="/fork/numbat/ref/master/tree/book/">book</a> / <a href="/fork/numbat/ref/master/tree/book/src/">src</a> / <span class="cur">unit-notation.md</span></nav>
<span class="view-stats"><span>1.3 KiB</span><span>29 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/a8ad91765f3f18c0229cc0e9efad3ade4ae47fb4/book/src/unit-notation.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"><h1>Unit notation</h1>
<p>Most units can be entered in the same way that they would appear in textbook calculations. They
usually have a long form (<code>meter</code>, <code>degrees</code>, <code>byte</code>, …), a plural form (<code>meters</code>, <code>degrees</code>, <code>bytes</code>),
and a short alias (<code>m</code>, <code>°</code>, <code>B</code>). For a full list of supported units, see
<a href="/fork/numbat/ref/master/blob/book/src/list-units.md">this page</a>.</p>
<p>All SI-accepted units support <a href="https://en.wikipedia.org/wiki/Metric_prefix">metric prefixes</a> (<code>mm</code>, <code>cm</code>, <code>km</code>, ... or <code>millimeter</code>, <code>centimeter</code>, <code>kilometer</code>, ...)
and — where sensible — units allow for <a href="https://en.wikipedia.org/wiki/Binary_prefix">binary prefixes</a> (<code>MiB</code>, <code>GiB</code>, ... or <code>mebibyte</code>, <code>gibibyte</code>, ...). Note
that the short-form prefixes can only be used with the short version of the unit, and vice versa (that is: <code>kmeter</code> and <code>kilom</code> are <em>not</em> allowed, only <code>km</code> and <code>kilometer</code>).</p>
<p>Units can be combined using <a href="/fork/numbat/ref/master/blob/book/src/operations.md">mathematical operations</a> such as multiplication, division and exponentiation: <code>kg * m/s^2</code>, <code>km/h</code>, <code>m²</code>, <code>meter per second</code>.</p>
<p>The following snippet shows various styles of entering units:</p>
<pre>2 min + 1 s
150 cm
sin(30°)
50 mph
6 MiB

2 minutes + 1 second
150 centimeters
sin(30 degrees)
50 miles per hour
6 mebibyte
</pre>
<p>Note that Numbat also allows you to <a href="/fork/numbat/ref/master/blob/book/src/unit-definitions.md">define new units</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>#</a-p> <a-tt>Unit notation</a-tt></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">Most units can be entered in the same way that they would appear in textbook calculations. They</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">usually have a long form (`meter`, `degrees`, `byte`, …), a plural form (`meters`, `degrees`, `bytes`),</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">and a short alias (`m`, `°`, `B`). For a full list of supported units, see</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">[this page](./list-units.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">All SI-accepted units support [metric prefixes](https://en.wikipedia.org/wiki/Metric_prefix) (`mm`, `cm`, `km`, ... or `millimeter`, `centimeter`, `kilometer`, ...)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">and — where sensible — units allow for [binary prefixes](https://en.wikipedia.org/wiki/Binary_prefix) (`MiB`, `GiB`, ... or `mebibyte`, `gibibyte`, ...). Note</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">that the short-form prefixes can only be used with the short version of the unit, and vice versa (that is: `kmeter` and `kilom` are *not* allowed, only `km` and `kilometer`).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">Units can be combined using [mathematical operations](./operations.md) such as multiplication, division and exponentiation: `kg * m/s^2`, `km/h`, `m²`, `meter per second`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">The following snippet shows various styles of entering units:</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>```</a-p><a-tl>nbt</a-tl></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>2 min + 1 s</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"><a-p>150 cm</a-p></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>sin(30°)</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"><a-p>50 mph</a-p></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>6 MiB</a-p></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>2 minutes + 1 second</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"><a-p>150 centimeters</a-p></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>sin(30 degrees)</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"><a-p>50 miles per hour</a-p></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>6 mebibyte</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>```</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">Note that Numbat also allows you to [define new units](./unit-definitions.md).</span></span></pre></div></div>
</main>
</body>
</html>
