Skip to content

tamc/how-much-is

Repository files navigation

how-much-is

I wrote this tool to help me understand numbers in different units. The purpose of the tool is to be practical. Therefore it is content to deal in units and conversions that are ambiguous (e.g., $100/barrel) or not strictly correct (e.g., ppm which could be µkg/kg or µm3/m3).

Canonical source: http://github.com/tamc/how-much-is

License: © 2014-18 [email protected] - Open source MIT licence.

Warnings:

  • Take care: I take no responsiblity for the consequences of errors in this software.
  • Take care: This tool reflects my preference, and so the conversion outputs have the same significant figures as the inputs. Therefore don't naively use this as a source of conversion factors. Look in Units.tsv for that, or better yet, go to an authoritative source.
  • Take care: This tool uses the number precision of the underlying javascript environment. So, errors can creep in. If you feel like converting the code to use a bigdecimal arithmetic library, that would be brilliant.

Adding or editing units

Edit units.tsv to add a new unit. It is easiest to edit this file in a spreadsheet program. Once edited, either email the new copy to me at [email protected] or, if you know how, use github to fork and pull.

The file has one row per unit. By unit we mean suffix that might be added to a number. So kilograms and grams get separate rows.

Each row has:

  • name - the conventional name of the unit, in plural form, capitalised correctly (e.g., seconds)
  • symbol - the conventional symbol for that unit, captialised correctly (e.g., s)
  • aliases - other, possibly incorrect, ways the unit is referred to (e.g, sec for second). Separate alternatives with a comma (e.g., second, sec, secs). No need to worry about the various ways the name might be capitalised, hyphenated or spaced. Do include plurals unless they are simply the addition of an s at the end of a word.
  • equivalent_to - the unit in another unit (e.g., for a minute, we put 60s). A few more details on this are below.
  • description - start with the singular name in bold, then what it is, then who uses it and for what.
  • source - a reputable source for the conversion. The NIST is a good source. Wikipedia less so.
  • exclude_from_results - if this contains YES then this unit can be used as an input, but won't appear as an output conversion. This is appropriate for things that people commonly use as units (e.g., homes) but aren't reccomended, so we don't want to show them when people input different units.

The equivalent_to column can contain a number and unit written in any other unit. If that unit appears elsewhere in the table, then it is assumed that a number in this unit can be converted into that other unit and any unit that the other unit can be converted into. So, for example, if we have:

nameequivalent_to
gram1 gram
kilogram1000 gram
pound0.4536 kilogram
blob12 slugs
meter1 meter
kilometer1000 meters

Then a kilogram can be converted to a gram. A pound can also be converted to a gram, because pound has been given a unit in kilograms, and kilograms has been given a unit in grams. However, the system can't convert a blob into a kilogram, despite the blob being a recognised unit of mass. This is because it can convert a blob into a slug, but there is no definition of slug and, in particular, there is no definition of slug that refers to either a gram or a kilogram or a pound. This is the same reason the system won't convert a kilometer into a gram.

About

I wrote this tool to help me understand numbers in different units.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published