Skip to main content

ucon

Pronounced: yoo · cahn

tests publish

Background

Numbers are particularly helpful when describing quantities of some thing (say, 42 ice cream cones 🍦). They are also useful when describing characteristics of a thing such as it's weight or volume. Being able to describe a thing by measurements of its defining features and even monitoring said features over time, is foundational to developing an understanding of how the thing works in the world. "Units" is the general term for those quantifying descriptors that characterize an object. Specific units include those like grams for weight, liter for volume, and even the jiffy for time. With means to refer to an object's physical characteristics, their extent can be communicated using a scale to answer the question: "how many of a given unit accurately describe that aspect of the object?".

Introduction

Since the metric scale is fairly ubiquitous and straightfowrward to count with (being base 10 and all..), ucon uses the Metric System as the basis for measurement though binary prefixes are also supported. The crux of this tiny library is to provide abstractions that simplify the answering of questions like:

"If given two milliliters of bromine (liquid Br2), how many grams of bromine does one have?"

To best answer this question, we turn to an age-old technique (dimensional analysis) which essentially allows for the solution to be written as a product of ratios.

 2 mL bromine | 3.119 g bromine
--------------x-----------------  #=> 6.238 g bromine
      1       |  1 mL bromine

Usage

The above calculation can be achieved using types defined in the ucon module.

two_milliliters_bromine = Number(unit=Units.liter, scale=Scale.milli, quantity=2)
bromine_density = Ratio(numerator=Number(unit=Units.gram, quantity=3.119)
                        denominator=Number(unit=Units.liter, scale=Scale.milli))
two_milliliters_bromine * bromine_density  #=> <6.238 gram>

One can also arbitrarily change scale:

answer = two_milliliters_bromine * bromine_density  #=> <6.238 gram>
answer.to(Scale.milli)                              #=> <6238.0 milligram>
answer.to(Scale.kibi)                               #=> <0.006091796875 kibigram>

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ucon-0.2.1.tar.gz (2.8 kB view details)

Uploaded Source

File details

Details for the file ucon-0.2.1.tar.gz.

File metadata

  • Download URL: ucon-0.2.1.tar.gz
  • Upload date:
  • Size: 2.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for ucon-0.2.1.tar.gz
Algorithm Hash digest
SHA256 e405c5673fa459627c52c1837f92e5fed5360a5ee638b3bdde0de2d6850102b8
MD5 a510e6d86ac6348429f7f14e33f0bdb6
BLAKE2b-256 c407059babcae83788fc0833069b23d07eaf92b08d57fbed584fd4a518b67e8b

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.2.1

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page