• Stars
    star
    734
  • Rank 61,748 (Top 2 %)
  • Language
    Rust
  • License
    Apache License 2.0
  • Created over 2 years ago
  • Updated 9 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A statically typed programming language for scientific computations with first class support for physical dimensions and units

Try online! • Documentation • Tutorial • Syntax reference • Installation • Development

Numbat is a statically typed programming language for scientific computations
with first class support for physical dimensions and units.

Key Features

Click to learn more.

Physical dimensions as types

Numbat has a static type system where physical dimensions like Length and Time 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 (Speed, Money and Frequency in the screenshot).

See this article to learn more about Numbat's type system.

First-class physical units

Numbat is focused on computations with units. Units are therefore treated as first-class citizens. They can be entered in various ways (km/h or kilometer/hour, GiB or gibibytes, ° or degree, m² or m^2). New units can be introduced on the spot (unit pixel). Compatible units can be converted easily using the -> operator (30 km/h -> mph, 1 mrad -> degree, 5 in + 2 ft -> cm, 27 weeks -> days). And unit expressions are simplified using various heuristics (15 km/h * 30 min = 7.5 km).

Comprehensive standard library

Numbat's standard library comes with a large number of physical dimensions and units (SI, US Customary, Imperial, Nautical, Astronomical, Atomic, Nuclear, …). See this reference page for a complete overview. It also contains a lot of mathematical and physical constants as well as a large range of pre-defined functions.

Strict syntax

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.

Excellent error messages

Numbat aims to provide descriptive and helpful error messages.

Interactive terminal

Numbat has been designed for an interactive use-case with small "one off" computations. Opening the numbat interpreter without any arguments starts a REPL with a familiar readline interface, including all the usual features like a command history, Ctrl-R search or tab completion.

Modular and customizable

The whole system of physical dimensions and units is specified Numbat's standard library, which is written in the Numbat language itself. It is therefore easily extensible by providing a init.nbt file. For example, a single line (unit bathtub = 150 L) is usually enough to add a new unit. Users can even choose to write their own prelude module, allowing for arbitrary modifications to the unit system.

Assertions

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 assert_eq procedure that allows you to check for exact equality using assert_eq(12 ft, 1 in) or approximate equality using assert_eq(c, 300_000 km/s, 1% × c). This can be useful to make sure that intermediate results do not change during a restructuring of your calculation.

Non-features

Numbat is a scientific calculator. It's not a computer algebra system that solves differential equations or computes intergrals. Try WolframAlpha instead.
There is no graphical user interface with buttons like x², 1/x or DEG/RAD. Qalculate! is a fantastic tool that supports both text as well as graphical input.
Numbat supports a huge range of physical units. If you need something even more comprehensive, please consider contributing. Or try GNU units.

 

 

 

 

Installation

See this page for details on how to install the native command-line version of Numbat.

Development

Run Numbat CLI

cargo run -- <numbat args>

Install the CLI version

cargo install -f --path numbat-cli

Run all tests

cargo test

Working on the prelude

If you are working on Numbat's standard library, it is convenient to point the NUMBAT_MODULES_PATH environment variable to the numbat/modules/ folder. This way, you don't have to recompile Numbat to see your changes.

Alternatively, you can create a symlink from ~/.config/numbat/modules to the numbat/modules/ folder in the repository (see this page for the standard paths on other operating systems).

Contact us

To contact us, either open a GitHub issue or discussion, or pop into #numbat on Libera.Chat (link to webchat).

More Repositories

1

bat

A cat(1) clone with wings.
Rust
48,695
star
2

fd

A simple, fast and user-friendly alternative to 'find'
Rust
33,228
star
3

hyperfine

A command-line benchmarking tool
Rust
18,256
star
4

hexyl

A command-line hex viewer
Rust
8,565
star
5

pastel

A command-line tool to generate, analyze, convert and manipulate colors
Rust
4,746
star
6

insect

High precision scientific calculator with support for physical units
PureScript
3,147
star
7

dbg-macro

A dbg(…) macro for C++
C++
2,719
star
8

cube-composer

A puzzle game inspired by functional programming
PureScript
1,967
star
9

vivid

A themeable LS_COLORS generator with a rich filetype datebase
Rust
1,479
star
10

shell-functools

Functional programming tools for the shell
Python
1,133
star
11

binocle

a graphical tool to visualize binary data
Rust
964
star
12

diskus

A minimal, fast alternative to 'du -sh'
Rust
936
star
13

great-puzzles

A curated list of great puzzles
484
star
14

purescript-flare

A special-purpose UI library for Purescript
PureScript
286
star
15

lscolors

A Rust library and tool to colorize paths using LS_COLORS
Rust
235
star
16

trigger

Run a user-defined command on file changes
Shell
181
star
17

bugreport

Rust library to collect system and environment information for bug reports
Rust
131
star
18

quizzity

A fast-paced geography quiz
JavaScript
125
star
19

curiosity

How far does your curiosity take you?
HTML
99
star
20

lucid

A simple mock-application for programs that work with child processes
Rust
86
star
21

parachuting-robots

An interactive version of a classic puzzle
PureScript
78
star
22

purescript-sparkle

Infer user interfaces from type signatures
PureScript
75
star
23

stack-inspector

A gdb command to inspect the size of objects on the stack
Python
62
star
24

painless

Painless parameter handling for easy exploration
C++
60
star
25

yinsh

A web-based version of the board game Yinsh
Haskell
59
star
26

purescript-isometric

Isometric rendering for PureScript
PureScript
58
star
27

pysh

Python-enhanced bash scripts
Python
58
star
28

purescript-quantities

Physical quantities and units
PureScript
53
star
29

minicpp

A REPL-style development environment for small C++ snippets
Shell
48
star
30

purescript-ctprelude

A Prelude with names from category theory
PureScript
48
star
31

qrnet

A neural network that decrypts QR codes
Python
43
star
32

riffle

A simple terminal pager (as a library)
Rust
41
star
33

config-files

A set of configuration files for vim, zsh, i3, ...
Python
37
star
34

content_inspector

Fast inspection of binary buffers to guess/determine the type of content
Rust
32
star
35

factorization-diagrams

Interactive factorization diagrams
HTML
27
star
36

argmax

Rust library to deal with "argument too long" errors
Rust
20
star
37

vacuum-robot-simulator

Simulation environment for an autonomous robot
Rust
19
star
38

sub

A command-line tool for string substitutions (RustLab 2019 workshop)
Rust
16
star
39

purescript-format

Type-safe, printf-style formatting for PureScript
PureScript
15
star
40

PaperLocator

Citation parsing to quickly access publications
JavaScript
14
star
41

purescript-decimals

Arbitrary precision numbers for PureScript
PureScript
13
star
42

flare-example

Quick start project for purescript-flare
PureScript
11
star
43

fd-benchmarks

Benchmarks for 'fd'
Shell
10
star
44

tinytag

tinytag is a "URL" shortener for your filesystem
Python
10
star
45

purescript-flaredoc

Interactive documentation with Flare
PureScript
8
star
46

phd-thesis

LaTeX sources for my PhD thesis
TeX
7
star
47

level11

7
star
48

GPE-Solver

Split-step solver for the 3D (dipolar) Gross-Pitaevskii equation
C++
7
star
49

Pack-Zack

A tag-based manager for packing lists
CSS
7
star
50

latex-report

A clean and simple LaTeX template for reports
TeX
7
star
51

dp

Personal website about some of my open source projects, board games and mountainbiking.
HTML
5
star
52

cs231n

My solutions to the CS231n assignments
Jupyter Notebook
4
star
53

imdb-ratings

Statistical analysis of my IMDB movie ratings
Jupyter Notebook
3
star
54

purescript-pairs

Datatype and functions for pairs of values
PureScript
3
star
55

zehntausend

A solver for the dice game Zehntausend
Haskell
3
star
56

gnuplot-mm

GnuPlot bindings for Mathematica
Mathematica
2
star
57

talk-moderne-programmiersprachen

JavaScript
2
star
58

rock-paper-scissors

Interactive regex puzzle
HTML
2
star
59

purescript-gametree

Algorithms for two-player zero-sum games
PureScript
2
star
60

snake-factory

A work-in-progress game with monadic parsers and snakes
PureScript
1
star
61

gomoku

Five in a row
PureScript
1
star