No description
Find a file
Tiffany Bennett a13b9fcbaf
Markup for doc strings (#177)
Makes Rink parse out the links and date strings when using the token
format machinery. This is a new syntax in the definitions file with
`<abc>` for links and `#abc#` for dates.

Replaced ansi_term with nu-ansi-term because the former was
unmaintained. The latter comes with the ability to set hyperlinks.
2024-05-27 16:51:42 -07:00
.github/workflows Fix code coverage (#175) 2024-05-10 21:28:19 -07:00
cli Markup for doc strings (#177) 2024-05-27 16:51:42 -07:00
core Markup for doc strings (#177) 2024-05-27 16:51:42 -07:00
docs Markup for doc strings (#177) 2024-05-27 16:51:42 -07:00
irc v0.8.0 2024-04-20 19:35:30 -07:00
rink-js v0.8.0 2024-04-20 19:35:30 -07:00
sandbox v0.8.0 2024-04-20 19:35:30 -07:00
web Markup for doc strings (#177) 2024-05-27 16:51:42 -07:00
.codecov.yml Add Travis and Codecov configuration 2018-11-15 18:55:45 +01:00
.editorconfig Rink-web 3 (#165) 2024-04-20 18:46:50 -07:00
.gitignore Cache currency data in a file for better reliability 2021-02-14 16:46:17 -08:00
.tokeignore Add tokei ignore file 2022-04-03 21:10:38 -07:00
.travis.yml Fix pattern in kcov invocation 2018-11-20 22:26:35 +01:00
Cargo.lock Markup for doc strings (#177) 2024-05-27 16:51:42 -07:00
Cargo.toml Dependencies cleanup (#163) 2024-03-31 14:34:09 -07:00
LICENSE-GPL Switch to MPL 2016-08-22 10:46:22 -04:00
LICENSE-MPL Switch to MPL 2016-08-22 10:46:22 -04:00
Makefile Remove unnecessary -t from Makefile 2024-05-21 20:13:29 -07:00
PACKAGING.md Split the make install rule (#170) 2024-05-01 18:59:39 -07:00
README.md v0.8.0 2024-04-20 19:35:30 -07:00

Rink

codecov crates.io downloads

https://rinkcalc.app/about

Rink is an open source unit-aware calculator. It can be used for physics and engineering calculations, as well as dimensionality analysis.

Rink supports most systems of measurements including SI, CGS, natural, international customary, US customary, UK customary, as well as historical measurements. In addition, Rink supports currency conversions.

Features

  • Arbitrary precision math
  • Shows SI physical quantities
  • Finds applicable SI derived units automatically
  • Detailed error messages
  • Helps with dimensionality analysis, such as by offering unit factorizations and finding units for quantities.
  • Temperature conversions

Manual

Describes (hopefully) everything you need to know to use Rink's expression language.

Install

The most common version of Rink is the command line interface rink.

Package Manager Command
Cargo cargo install rink
Pacman pacman -S rink
Nix nix-env -i rink
Scoop scoop install rink

Downloads are also available at https://rinkcalc.app/releases.

Web Interface: rinkcalc.app

Rink is available via a web interface in addition to the terminal-based interface. Useful for doing calculations on mobile.

Examples

How much does it cost to run my computer each year? Say it uses 100 watts for 4 hours per day, and use the US average electricity cost.

> 0.1545$/kWh * 100W * (4 hours / day) to $/year
approx. 22.57196 USD / tropicalyear

If you made a solid sphere of gold the size of the moon, what would the surface gravity be?

> volume of moon * (19.283 g/cm^3) * G / (radius of moon)^2
approx. 9.365338 meter / second^2 (acceleration)
> ans to gravity
approx. 0.9549987 gravity (acceleration)

Ever heard someone joke about Americans measuring fuel efficiency as rods per hogshead? Let's try with the average US car fuel efficiency.

> 9.4 km/l to mpg
approx. 22.11017 mpg (fuel_efficiency)
> 9.4 km/l to rods per hogshead
approx. 445741.0 rod / ushogshead (fuel_efficiency)

And then you wonder, wait, what even are these units anyway?

> hogshead
Definition: ushogshead = 2 liquidbarrel = approx. 238480942.3 millimeter^3 (volume; m^3)
> liquidbarrel
Definition: liquidbarrel = 31.5 usgallon = approx. 119240471.1 millimeter^3 (volume; m^3)
> rod
Definition: rod = 5.5 yard = 5.0292 meter (length; m)

Library Usage

docs.rs

[dependencies]
rink-core = "0.8"

License

Rink source code is licensed under the Mozilla Public License, version 2. See LICENSE-MPL for details.

The data file definitions.units is licensed under the GNU General Public License, version 3. See LICENSE-GPL for details.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work will grant the rights lined out in the MPL, including larger works with secondary licenses.

If you plan on making edits to definitions.units, check out the documentation here: docs/rink-defs.5.adoc

Changelog

See here: https://rinkcalc.app/releases