Merge pull request #178 from CitrineInformatics/maintain/update-pint

Update Pint interactions to be compatible with latest release

Author: kroenlein

gemd/units/citrine_en.txt

@@ -1,6 +1,6 @@
 # Citrine customized units input file for Pint, based explicitly on the Pint defaults as
-# included release 0.9 (https://github.com/hgrecco/pint/releases/tag/0.9).  The Pint Authors hold
-# copyright and are documented in https://github.com/hgrecco/pint/blob/0.9/AUTHORS.
+# included release 0.20 (https://github.com/hgrecco/pint/releases/tag/0.20).  The Pint Authors hold
+# copyright and are documented in https://github.com/hgrecco/pint/blob/0.20/AUTHORS.
 #
 # The original copyright statement for the constants file reads:
 #
@@ -80,7 +80,7 @@
 #     [density] = [mass] / [volume]
 #
 # Note that primary dimensions don't need to be declared; they can be
-# defined or the first time in a unit definition.
+# defined for the first time in a unit definition.
 # E.g. see below `meter = [length]`
 #
 #
@@ -112,7 +112,9 @@ atto- =  1e-18 = a-
 femto- = 1e-15 = f-
 pico- =  1e-12 = p-
 nano- =  1e-9  = n-
-micro- = 1e-6  = µ- = u-
+# The micro (U+00B5) and Greek mu (U+03BC) are both valid prefixes,
+# and they often use the same glyph.
+micro- = 1e-6  = µ- = μ- = u-
 milli- = 1e-3  = m-
 centi- = 1e-2  = c-
 deci- =  1e-1  = d-
@@ -152,7 +154,6 @@ gram = [mass] = g = Gram
 mole = [substance] = mol = Mole
 kelvin = [temperature]; offset: 0 = K = Kelvin = degK = °K = degree_Kelvin = degreeK  # older names supported for compatibility
 radian = [] = rad = Radian
-neper = [] = Np = Neper
 bit = [] = _ = Bit
 count = [] = _ = Count
 
@@ -180,13 +181,13 @@ mil = π / 32000 * radian = Mil
 steradian = radian ** 2 = sr = Steradian
 square_degree = (π / 180) ** 2 * sr = sq_deg = sqdeg = Square_Degree
 
-# Logarithmic ratio
-bel = 0.5 * ln10 * neper = Bel
-
 # Information
-byte = 8 * bit = B = octet = Byte = Octet
 baud = bit / second = Bd = bps = Baud = BPS
 
+byte = 8 * bit = B = octet = Byte = Octet
+# byte = 8 * bit = _ = octet
+## NOTE: B (byte) symbol can conflict with Bell
+
 # Length
 angstrom = 1e-10 * meter = Å = ångström = Angstrom = Ångstrom = Å
 micron = micrometer = µ = Micron
@@ -198,7 +199,7 @@ nautical_mile = 1852 * meter = nmi = Nautical_Mile
 bohr = hbar / (alpha * m_e * c) = a_0 = a0 = Bohr = bohr_radius = atomic_unit_of_length = a_u_length
 x_unit_Cu = K_alpha_Cu_d_220 * d_220 / 1537.4 = Xu_Cu
 x_unit_Mo = K_alpha_Mo_d_220 * d_220 / 707.831 = Xu_Mo
-angstrom_star = K_alpha_W_d_220 * d_220 / 0.2090100 = Å_star = Angstrom_Star
+angstrom_star = K_alpha_W_d_220 * d_220 / 0.2090100 = Å_star = Angstrom_Star = Ångstrom_Star
 planck_length = (hbar * gravitational_constant / c ** 3) ** 0.5 = Planck_length = Planck_Length
 
 # Mass
@@ -218,7 +219,10 @@ week = 7 * day = Week
 fortnight = 2 * week = Fortnight
 year = 365.25 * day = yr = julian_year = Year = Julian_year = Julian_Year
 month = year / 12 = _ = Month
-decade = 10 * year = _ = Decade
+
+# decade = 10 * year = _ = Decade
+## NOTE: decade [time] can conflict with decade [dimensionless]
+
 century = 100 * year = _ = centuries = Century = Centuries
 millennium = 1e3 * year = _ = millennia = Millennium = Millennia
 eon = 1e9 * year = _ = Eon
@@ -262,21 +266,27 @@ stere = meter ** 3 = _ = Stere
 [frequency] = 1 / [time]
 hertz = 1 / second = Hz = Hertz
 revolutions_per_minute = revolution / minute = rpm = Revolutions_Per_Minute = RPM
+revolutions_per_second = revolution / second = rps = Revolutions_Per_Second = RPS
 counts_per_second = count / second = cps = Counts_Per_Second = CPS
 
 # Wavenumber
 [wavenumber] = 1 / [length]
 reciprocal_centimeter = 1 / cm = cm_1 = kayser = Kayser = Reciprocal_Centimeter
 
 # Velocity
-[velocity] = [length] / [time] = [speed]
+[velocity] = [length] / [time]
+[speed] = [velocity]
 knot = nautical_mile / hour = kt = knot_international = international_knot = Knot = International_Knot
 mile_per_hour = mile / hour = mph = MPH = Mile_Per_Hour = Miles_Per_Hour = miles_per_hour
 kilometer_per_hour = kilometer / hour = kph = KPH = kilometers_per_hour = Kilometer_Per_Hour = Kilometers_Per_Hour
 kilometer_per_second = kilometer / second = kps = kilometers_per_second = Kilometer_Per_Second
 meter_per_second = meter / second = mps = Meter_Per_Second = Meters_Per_Second
 foot_per_second = foot / second = fps = feet_per_second = Foot_Per_Second = Feet_Per_Second
 
+# Volumetric Flow Rate
+[volumetric_flow_rate] = [volume] / [time]
+sverdrup = 1e6 * meter ** 3 / second = sv
+
 # Acceleration
 [acceleration] = [velocity] / [time]
 galileo = centimeter / second ** 2 = Gal = Galileo
@@ -296,7 +306,7 @@ joule = newton * meter = J = Joule
 erg = dyne * centimeter = _ = Erg
 watt_hour = watt * hour = Wh = watthour = Whr = Watt_Hour = Watthour
 electron_volt = e * volt = eV
-rydberg = h * c * R_inf = Ry = Rydberg
+rydberg = ℎ * c * R_inf = Ry = Rydberg
 hartree = 2 * rydberg = E_h = Eh = Hartree = hartree_energy = atomic_unit_of_energy = a_u_energy
 calorie = 4.184 * joule = cal = thermochemical_calorie = cal_th = Calorie = Thermochemical_Calorie
 international_calorie = 4.1868 * joule = cal_it = international_steam_table_calorie = International_Calorie
@@ -320,9 +330,13 @@ boiler_horsepower = 33475 * Btu / hour                            # unclear whic
 metric_horsepower = 75 * force_kilogram * meter / second
 electrical_horsepower = 746 * watt
 refrigeration_ton = 12e3 * Btu / hour = _ = ton_of_refrigeration  # approximate, no exact definition
+cooling_tower_ton = 1.25 * refrigeration_ton # approximate, no exact definition
 standard_liter_per_minute = atmosphere * liter / minute = slpm = slm
 conventional_watt_90 = K_J90 ** 2 * R_K90 / (K_J ** 2 * R_K) * watt = W_90
 
+# Momentum
+[momentum] = [length] * [mass] / [time]
+
 # Density (as auxiliary for pressure)
 [density] = [mass] / [volume]
 mercury = 13.5951 * kilogram / liter = Hg = Hg_0C = Hg_32F = conventional_mercury
@@ -348,6 +362,7 @@ inch_H2O_39F = inch * water_39F * g_0
 inch_H2O_60F = inch * water_60F * g_0
 foot_H2O = foot * water * g_0 = ftH2O = feet_H2O
 centimeter_H2O = centimeter * water * g_0 = cmH2O = cm_H2O
+sound_pressure_level = 20e-6 * pascal = SPL
 
 # Torque
 [torque] = [force] * [length]
@@ -381,7 +396,7 @@ enzyme_unit = micromole / minute = U = enzymeunit
 
 # Entropy
 [entropy] = [energy] / [temperature]
-clausius = calorie / kelvin = _ = Clausius
+clausius = calorie / kelvin = Cl = Clausius
 
 # Molar entropy
 [molar_entropy] = [entropy] / [substance]
@@ -474,17 +489,17 @@ farad = coulomb / volt = F
 abfarad = 1e9 * farad = abF
 conventional_farad_90 = R_K90 / R_K * farad = F_90
 
+# Magnetic flux
+[magnetic_flux] = [electric_potential] * [time]
+weber = volt * second = Wb = Weber
+unit_pole = µ_0 * biot * centimeter
+
 # Inductance
 [inductance] = [magnetic_flux] / [current]
 henry = weber / ampere = H = Henry
 abhenry = 1e-9 * henry = abH
 conventional_henry_90 = R_K / R_K90 * henry = H_90
 
-# Magnetic flux
-[magnetic_flux] = [electric_potential] * [time]
-weber = volt * second = Wb = Weber
-unit_pole = µ_0 * biot * centimeter
-
 # Magnetic field
 [magnetic_field] = [magnetic_flux] / [area]
 tesla = weber / meter ** 2 = T = Tesla
@@ -494,7 +509,7 @@ gamma = 1e-9 * tesla = γ
 [magnetomotive_force] = [current]
 ampere_turn = ampere = At
 biot_turn = biot
-gilbert = 1 / (4 * π) * biot_turn = _ = Gilbert
+gilbert = 1 / (4 * π) * biot_turn = _ = Gilbert  # Remove Gb for risk of collision with GB
 
 # Magnetic field strength
 [magnetic_field_strength] = [current] / [length]
@@ -512,6 +527,27 @@ buckingham = debye * angstrom = Buckingham
 bohr_magneton = e * hbar / (2 * m_e) = µ_B = mu_B
 nuclear_magneton = e * hbar / (2 * m_p) = µ_N = mu_N
 
+# Logaritmic Unit Definition
+#  Unit = scale; logbase; logfactor
+#  x_dB = [logfactor] * log( x_lin / [scale] ) / log( [logbase] )
+
+# Logaritmic Units of dimensionless quantity: [ https://en.wikipedia.org/wiki/Level_(logarithmic_quantity) ]
+
+decibelmilliwatt = 1e-3 watt; logbase: 10; logfactor: 10 = dBm
+decibelmicrowatt = 1e-6 watt; logbase: 10; logfactor: 10 = dBu
+
+decibel = 1 ; logbase: 10; logfactor: 10 = dB
+# bell = 1 ; logbase: 10; logfactor: = B
+## NOTE: B (Bell) symbol conflicts with byte
+
+decade = 1 ; logbase: 10; logfactor: 1
+## NOTE: decade [time] can conflict with decade [dimensionless]
+
+octave = 1 ; logbase: 2; logfactor: 1 = oct
+
+neper = 1 ; logbase: 2.71828182845904523536028747135266249775724709369995; logfactor: 0.5 = Np = Neper
+# neper = 1 ; logbase: eulers_number; logfactor: 0.5 = Np
+## NOTE: using eulers_number in a logbase definition seems broken under Pint 0.19.2, 0.20.0
 
 #### UNIT GROUPS ####
 # Mostly for length, area, volume, mass, force
@@ -580,7 +616,7 @@ nuclear_magneton = e * hbar / (2 * m_p) = µ_N = mu_N
     teaspoon = fluid_ounce / 6 = tsp
     tablespoon = fluid_ounce / 2 = tbsp = Tbsp
     shot = 3 * tablespoon = jig = US_shot
-    cup = pint / 2 = _ = liquid_cup = US_liquid_cup
+    cup = pint / 2 = _ = liquid_cup = US_liquid_cup  # Removed because of risk of collision with cP
     barrel = 31.5 * gallon = bbl
     oil_barrel = 42 * gallon = oil_bbl
     beer_barrel = 31 * gallon = beer_bbl
@@ -599,6 +635,7 @@ nuclear_magneton = e * hbar / (2 * m_p) = µ_N = mu_N
     ton = 2e3 * pound = _ = short_ton
     long_ton = 2240 * pound
     slug = g_0 * pound * second ** 2 / foot
+    slinch = g_0 * pound * second ** 2 / inch = blob = slugette
 
     force_ounce = g_0 * ounce = ozf = ounce_force
     force_pound = g_0 * pound = lbf = pound_force
@@ -621,9 +658,9 @@ nuclear_magneton = e * hbar / (2 * m_p) = µ_N = mu_N
 @end
 
 @group Troy
-    pennyweight = 24 * grain = _ = pennyweight
-    troy_ounce = 480 * grain = _ = troy_ounce
-    troy_pound = 12 * troy_ounce = _ = troy_pound
+    pennyweight = 24 * grain = dwt
+    troy_ounce = 480 * grain = toz = ozt
+    troy_pound = 12 * troy_ounce = tlb = lbt
 @end
 
 @group Apothecary
@@ -650,7 +687,7 @@ nuclear_magneton = e * hbar / (2 * m_p) = µ_N = mu_N
 
 @group Printer
     pica = inch / 6 = _ = printers_pica
-    point = pica / 12 = _ = printers_point = big_point
+    point = pica / 12 = pp = printers_point = big_point = bp
     didot = 1 / 2660 * m
     cicero = 12 * didot
     tex_point = inch / 72.27

gemd/units/constants_en.txt

@@ -52,17 +52,17 @@
 #### MATHEMATICAL CONSTANTS ####
 # As computed by Maxima with fpprec:50
 
-pi    = 3.1415926535897932384626433832795028841971693993751 = π  # pi
-# ^^^^^    Uncommented pi definition
+pi     = 3.1415926535897932384626433832795028841971693993751 = π  # pi
 tansec = 4.8481368111333441675396429478852851658848753880815e-6   # tangent of 1 arc-second ~ arc_second/radian
 ln10   = 2.3025850929940456840179914546843642076011014886288      # natural logarithm of 10
 wien_x = 4.9651142317442763036987591313228939440555849867973      # solution to (x-5)*exp(x)+5 = 0 => x = W(5/exp(5))+5
 wien_u = 2.8214393721220788934031913302944851953458817440731      # solution to (u-3)*exp(u)+3 = 0 => u = W(3/exp(3))+3
+eulers_number = 2.71828182845904523536028747135266249775724709369995
 
 #### DEFINED EXACT CONSTANTS ####
 
 speed_of_light = 299792458 m/s = c = c_0                      # since 1983
-planck_constant = 6.62607015e-34 J s = h                      # since May 2019
+planck_constant = 6.62607015e-34 J s = ℎ                      # since May 2019
 elementary_charge = 1.602176634e-19 C = e                     # since May 2019
 avogadro_number = 6.02214076e23                               # since May 2019
 boltzmann_constant = 1.380649e-23 J K^-1 = k = k_B            # since May 2019
@@ -75,19 +75,19 @@ conventional_von_klitzing_constant = 2.5812807e4 ohm = R_K90  # since Jan 1990
 # Floating-point conversion may introduce inaccuracies
 
 zeta = c / (cm/s) = ζ
-dirac_constant = h / (2 * π) = ħ = hbar = atomic_unit_of_action = a_u_action
+dirac_constant = ℎ / (2 * π) = ħ = hbar = atomic_unit_of_action = a_u_action
 avogadro_constant = avogadro_number * mol^-1 = N_A
 molar_gas_constant = k * N_A = R
 faraday_constant = e * N_A
-conductance_quantum = 2 * e ** 2 / h = G_0
-magnetic_flux_quantum = h / (2 * e) = Φ_0 = Phi_0
-josephson_constant = 2 * e / h = K_J
-von_klitzing_constant = h / e ** 2 = R_K
-stefan_boltzmann_constant = 2 / 15 * π ** 5 * k ** 4 / (h ** 3 * c ** 2) = σ = sigma
-first_radiation_constant = 2 * π * h * c ** 2 = c_1
-second_radiation_constant = h * c / k = c_2
-wien_wavelength_displacement_law_constant = h * c / (k * wien_x)
-wien_frequency_displacement_law_constant = wien_u * k / h
+conductance_quantum = 2 * e ** 2 / ℎ = G_0
+magnetic_flux_quantum = ℎ / (2 * e) = Φ_0 = Phi_0
+josephson_constant = 2 * e / ℎ = K_J
+von_klitzing_constant = ℎ / e ** 2 = R_K
+stefan_boltzmann_constant = 2 / 15 * π ** 5 * k ** 4 / (ℎ ** 3 * c ** 2) = σ = sigma
+first_radiation_constant = 2 * π * ℎ * c ** 2 = c_1
+second_radiation_constant = ℎ * c / k = c_2
+wien_wavelength_displacement_law_constant = ℎ * c / (k * wien_x)
+wien_frequency_displacement_law_constant = wien_u * k / ℎ
 
 #### MEASURED CONSTANTS ####
 # Recommended CODATA-2018 values
@@ -109,10 +109,10 @@ K_alpha_W_d_220 = 0.108852175
 
 #### DERIVED CONSTANTS ####
 
-fine_structure_constant = (2 * h * R_inf / (m_e * c)) ** 0.5 = α = alpha
-vacuum_permeability = 2 * α * h / (e ** 2 * c) = µ_0 = mu_0 = mu0 = magnetic_constant
-vacuum_permittivity = e ** 2 / (2 * α * h * c) = ε_0 = epsilon_0 = eps_0 = eps0 = electric_constant
-impedance_of_free_space = 2 * α * h / e ** 2 = Z_0 = characteristic_impedance_of_vacuum
+fine_structure_constant = (2 * ℎ * R_inf / (m_e * c)) ** 0.5 = α = alpha
+vacuum_permeability = 2 * α * ℎ / (e ** 2 * c) = µ_0 = mu_0 = mu0 = magnetic_constant
+vacuum_permittivity = e ** 2 / (2 * α * ℎ * c) = ε_0 = epsilon_0 = eps_0 = eps0 = electric_constant
+impedance_of_free_space = 2 * α * ℎ / e ** 2 = Z_0 = characteristic_impedance_of_vacuum
 coulomb_constant = α * hbar * c / e ** 2 = k_C
 classical_electron_radius = α * hbar / (m_e * c) = r_e
 thomson_cross_section = 8 / 3 * π * r_e ** 2 = σ_e = sigma_e

gemd/units/impl.py

@@ -1,37 +1,33 @@
 """Implementation of units."""
-import pint
-from pint import UnitRegistry
-from pint.unit import _Unit
+from pint import UnitRegistry, Unit
 import pkg_resources
 
 import functools
 from typing import Union
 
+# alias the error that is thrown when units are incompatible
+# this helps to isolate the dependence on pint
+from pint.errors import DimensionalityError as IncompatibleUnitsError  # noqa Import
+from pint.errors import UndefinedUnitError
 
 # use the default unit registry for now
 DEFAULT_FILE = pkg_resources.resource_filename("gemd.units", "citrine_en.txt")
-_ureg = UnitRegistry(filename=DEFAULT_FILE)
-
-
-# alias the error that is thrown when units are incompatible
-# this helps to isolate the dependence on pint
-IncompatibleUnitsError = pint.errors.DimensionalityError
-UndefinedUnitError = pint.errors.UndefinedUnitError
+registry = UnitRegistry(filename=DEFAULT_FILE)
 
 
 @functools.lru_cache(maxsize=None)
-def parse_units(units: Union[str, _Unit, None]) -> Union[str, _Unit, None]:
+def parse_units(units: Union[str, Unit, None]) -> Union[str, Unit, None]:
     """
-    Parse a string or _Unit into a standard string representation of the unit.
+    Parse a string or Unit into a standard string representation of the unit.
 
     Parameters
     ----------
-    units: Union[str, _Unit, None]
-        The string or _Unit representation of the object we wish to display
+    units: Union[str, Unit, None]
+        The string or Unit representation of the object we wish to display
 
     Returns
     -------
-    [Union[str, _Unit, None]]
+    [Union[str, Unit, None]]
         The representation; note that the same type that was passed is returned
 
     """
@@ -40,8 +36,8 @@ def parse_units(units: Union[str, _Unit, None]) -> Union[str, _Unit, None]:
     elif units == '':
         return 'dimensionless'
     elif isinstance(units, str):
-        return str(_ureg(units).units)
-    elif isinstance(units, _Unit):
+        return str(registry(units).units)
+    elif isinstance(units, Unit):
         return units
     else:
         raise UndefinedUnitError("Units must be given as a recognized unit string or Units object")
@@ -70,7 +66,7 @@ def convert_units(value: float, starting_unit: str, final_unit: str) -> float:
     if starting_unit == final_unit:
         return value  # skip computation
     else:
-        return _ureg.Quantity(value, starting_unit).to(final_unit).magnitude
+        return registry.Quantity(value, starting_unit).to(final_unit).magnitude
 
 
 def change_definitions_file(filename: str = None):
@@ -83,8 +79,8 @@ def change_definitions_file(filename: str = None):
         The file to use
 
     """
-    global _ureg
+    global registry
     convert_units.cache_clear()  # Units will change
     if filename is None:
         filename = DEFAULT_FILE
-    _ureg = UnitRegistry(filename=filename)
+    registry = UnitRegistry(filename=filename)