added get_unit_type function

Author: ChrisBarker-NOAA

NUCOS_unit_list.txt

@@ -0,0 +1,249 @@
+NUCOS Unit List
+
+The NOAA Unit Converter for Oil Spills (NUCOS) is designed specifically to support
+oils spill response and planning. As the Oil industry (and the response community)
+use some unusual units, this is NOT a general purpose or full featured unit converter.
+However, it does try to include all the units that one might need for oil spill work.
+
+Complete unit type, units, and synonym list:
+
+Note that in NUCOS, unit names and synonyms are case and white space insensitive, so, eg:
+
+"Pounds per Cubic Foot" is the same as "poundspercubicfoot"
+
+All The Units:
+
+Length:
+    meter:  “meter”, “m”, “meters”, “metre”
+    centimeter:  “centimeter”, “cm”, “centimeters”
+    millimeter:  “millimeter”, “mm”, “millimeters”
+    micron:  “micron”, “µm”, “micrometer”, “microns”
+    kilometer:  “kilometer”, “km”, “kilometers”
+    foot:  “foot”, “ft”, “feet”
+    inch:  “inch”, “in”, “inches”
+    yard:  “yard”, “yd”, “yards”
+    mile:  “mile”, “mi”, “miles”
+    nautical mile:  “nautical mile”, “nm”, “nauticalmiles”
+    fathom:  “fathom”, “fthm”, “fathoms”
+    latitude degree:  “latitude degree”, “latitudedegrees”
+    latitude minute:  “latitude minute”, “latitudeminutes”
+
+Oil Concentration:
+    micron:  “micron”, “µm”, “microns”, “micrometer”
+    cubic meter per square kilometer:  “cubic meter per square kilometer”, “m³/km²”, “m^3/km^2”
+    millimeter:  “millimeter”, “mm”, “millimeters”
+    inch:  “inch”, “in”, “inches”
+    barrel per acre:  “barrel per acre”, “bbl/acre”
+    barrel per square mile:  “barrel per square mile”, “bbl/mile²”, “bbl/sq.mile”
+    gallon per acre:  “gallon per acre”, “gal/acre”
+    liter per hectare:  “liter per hectare”, “l/hectare”, “liter/hectare”
+    liter per square meter:  “liter per square meter”, “l/m²”, “l/m^2”
+    gram per square meter:  “gram per square meter”, “g/m²”, “g/m^2”
+    kilogram per square meter:  “kilogram per square meter”, “kg/m²”, “kg/m^2”
+    kilogram per square kilometer:  “kilogram per square kilometer”, “g/km²”, “kg/km^2”
+
+Area:
+    square meter:  “square meter”, “m²”, “m^2”, “sq m”
+    square centimeter:  “square centimeter”, “cm²”, “cm^2”, “sq cm”
+    square kilometer:  “square kilometer”, “km²”, “km^2”, “sq km”
+    acre:  “acre”, “ac”, “acres”
+    square mile:  “square mile”, “sq miles”
+    square nautical mile:  “square nautical mile”, “nm²”, “sq nm”, “nm^2”
+    square yard:  “square yard”, “yd²”, “sq yards”, “square yards”
+    square foot:  “square foot”, “ft²”, “ft^2”, “sq foot”, “square feet”
+    square inch:  “square inch”, “in²”, “in^2”, “sq inch”, “square inches”
+    hectare:  “hectare”, “ha”, “hectares”
+
+Volume:
+    cubic meter:  “cubic meter”, “m³”, “m^3”, “cu m”, “cubic meters”
+    cubic kilometer:  “cubic kilometer”, “km³”, “km^3”, “cu km”, “cubic kilometers”
+    cubic centimeter:  “cubic centimeter”, “cm³”, “cm^3”, “cu cm”, “cc”
+    milliliter:  “milliliter”, “ml”, “milliters”
+    barrel (petroleum):  “barrel (petroleum)”, “bbl”, “barrels”, “barrel”, “bbls”
+    liter:  “liter”, “l”, “liters”
+    gallon:  “gallon”, “gal”, “gallons”, “usgal”
+    gallon (UK):  “gallon (UK)”, “ukgal”, “gallons(uk)”
+    million US gallon:  “million US gallon”, “milgal”, “milliongallons”
+    cubic foot:  “cubic foot”, “ft³”, “ft^3”, “cu feet”, “cubicfeet”
+    cubic inch:  “cubic inch”, “in³”, “in^3”, “cu inch”, “cubicinches”
+    cubic yard:  “cubic yard”, “yd³”, “yd^3”, “cu yard”, “cubicyards”
+    fluid ounce:  “fluid ounce”, “oz”, “ounces(fluid)”, “fluid oz”
+    fluid ounce (UK):  “fluid ounce (UK)”, “ukoz”, “fluid oz(uk)”
+
+Temperature:
+    Kelvin:  “Kelvin”, “K”, “degrees k”, “degree k”, “degrees kelvin”, “degree kelvin”, “deg k”
+    Celsius:  “Celsius”, “°C”, “C”, “degrees c”, “degrees celsius”, “deg c”, “centigrade”
+    Fahrenheit:  “Fahrenheit”, “°F”, “F”, “degrees f”, “degree f”, “degrees fahrenheit”, “deg f”
+
+Delta Temperature:
+    Kelvin:  “Kelvin”, “K”, “degrees k”, “degree k”, “degrees kelvin”, “degree kelvin”, “deg k”
+    Celsius:  “Celsius”, “°C”, “C”, “degrees c”, “degree_c”, “degrees celsius”, “deg c”, “centigrade”
+    Fahrenheit:  “Fahrenheit”, “°F”, “F”, “degrees f”, “degree f”, “degree_f”, “deg f”, “degrees fahrenheit”
+
+Mass:
+    kilogram:  “kilogram”, “kg”, “kilograms”
+    pound:  “pound”, “lb”, “pounds”, “lbs”
+    gram:  “gram”, “g”, “grams”
+    milligram:  “milligram”, “mg”
+    microgram:  “microgram”, “µg”, “ug”
+    ton (US):  “ton (US)”, “ton”, “tons”, “uston”, “short ton”
+    metric ton (tonne):  “metric ton (tonne)”, “mt”, “tonne”, “tonnes”, “metric ton”, “metric tons”
+    slug:  “slug”, “slugs”
+    ounce:  “ounce”, “oz”, “ounces”
+    ton (UK):  “ton (UK)”, “ukton”, “long ton”
+
+Time:
+    second:  “second”, “s”, “sec”, “seconds”
+    minute:  “minute”, “min”, “minutes”
+    hour:  “hour”, “hr”, “hours”, “hrs”
+    day:  “day”, “days”
+
+Velocity:
+    meter per second:  “meter per second”, “m/s”, “meter/sec”, “meter/second”, “meters per second”, “mps”, “meter sec-1”, “meter second-1”, “meter seconds-1”, “meters sec-1”, “meters second-1”, “meters seconds-1”, “m s-1”, “meter s-1”, “meters s-1”
+    centimeter per second:  “centimeter per second”, “cm/s”
+    meter per minute:  “meter per minute”, “m/min”, “meters per minute”
+    kilometer per hour:  “kilometer per hour”, “km/h”, “km/hr”
+    kilometer per day:  “kilometer per day”, “km/day”, “km/d”
+    knot:  “knot”, “kt”, “kn”, “kts”, “knots”
+    mile per hour:  “mile per hour”, “mph”, “miles per hour”
+    foot per second:  “foot per second”, “ft/s”, “ft/sec”, “feet per second”, “feet/s”
+    foot per minute:  “foot per minute”, “ft/min”, “feet per minute”, “feet/min”
+    foot per hour:  “foot per hour”, “ft/hr”, “feet per hour”, “feet/hour”
+
+Discharge:
+    cubic meter per second:  “cubic meter per second”, “m³/s”, “m^3/s”, “cu m/s”, “cms”
+    cubic meter per min:  “cubic meter per min”, “m³/min”, “m^3/min”
+    cubic meter per hour:  “cubic meter per hour”, “m³/hr”, “m^3/hr”
+    liter per second:  “liter per second”, “l/s”, “lps”
+    liter per minute:  “liter per minute”, “l/min”
+    cubic foot per second:  “cubic foot per second”, “ft³/s”, “cfs”, “cu feet/s”, “feet^3/s”
+    cubic foot per minute:  “cubic foot per minute”, “ft³/min”, “ft^3/min”
+    gallon per day:  “gallon per day”, “gal/day”
+    gallon per hour:  “gallon per hour”, “gal/hr”
+    gallon per minute:  “gallon per minute”, “gal/min”, “gpm”
+    gallon per second:  “gallon per second”, “gal/s”, “gal/sec”
+    barrel per hour:  “barrel per hour”, “bbl/hr”
+    barrel per day:  “barrel per day”, “bbl/day”, “bbl/d”
+
+Mass Discharge:
+    kilogram per second:  “kilogram per second”, “kg/s”
+    gram per second:  “gram per second”, “g/s”
+
+Density:
+    gram per cubic centimeter:  “gram per cubic centimeter”, “g/cm³”, “g/cm^3”, “grams per cubic centimeter”
+    gram per liter:  “gram per liter”, “g/L”, “gram per litre”
+    kilogram per liter:  “kilogram per liter”, “kg/L”, “kilogram per litre”
+    gram per milliliter:  “gram per milliliter”, “g/mL”, “gram per millilitre”
+    specific gravity (15°C):  “specific gravity (15°C)”, “S”, “specificgravity”, “Spec grav”, “SG”, “specificgravity(15C)”
+    kilogram per cubic meter:  “kilogram per cubic meter”, “kg/m³”, “kg/m^3”
+    tonne per cubic meter:  “tonne per cubic meter”, “tonne/m³”, “tonne/m^3”, “t/m^3”, “t/m³”
+    pound per cubic foot:  “pound per cubic foot”, “lb/ft³”, “lbs/ft^3”, “lb/ft^3”
+    pound per gallon:  “pound per gallon”, “lb/gal”, “lbs/gal”
+    API degree:  “API degree”, “api”
+
+Kinematic Viscosity:
+    Stoke:  “Stoke”, “St”, “stokes”
+    centiStoke:  “centiStoke”, “cSt”, “centistokes”
+    square millimeter per second:  “square millimeter per second”, “mm²/s”, “mm^2/s”
+    square centimeter per second:  “square centimeter per second”, “cm²/s”, “cm^2/s”
+    square meter per second:  “square meter per second”, “m²/s”, “m^2/s”
+    square inch per second:  “square inch per second”, “in²/s”, “in^2/s”, “squareinchespersecond”
+    Saybolt Universal Second:  “Saybolt Universal Second”, “SSU”, “SUS”
+    Saybolt Furol Second:  “Saybolt Furol Second”, “SSF”, “SFS”
+
+Dynamic Viscosity:
+    kilogram per meter per second:  “kilogram per meter per second”, “kg/(m s)”
+    Pascal second:  “Pascal second”, “Pa s”
+    milliPascal second:  “milliPascal second”, “mPa s”
+    Newton seconds per square meter:  “Newton seconds per square meter”, “N s/m²”, “N s/m^2”
+    gram per centimeter per second:  “gram per centimeter per second”, “g/(cm s)”
+    poise:  “poise”, “p”
+    dyne seconds per square centimeter:  “dyne seconds per square centimeter”, “dyne s/cm²”, “dyne s/cm^2”
+    centipoise:  “centipoise”, “cP”
+
+Interfacial Tension:
+    Newton per meter:  “Newton per meter”, “N/m”
+    milliNewton per meter:  “milliNewton per meter”, “mN/m”
+    dyne per centimeter:  “dyne per centimeter”, “dyne/cm”, “dyn/cm”
+    Poundal per inch:  “Poundal per inch”, “pdl/in”
+    Pound force per inch:  “Pound force per inch”, “lbf/in”
+    erg per square centimeter:  “erg per square centimeter”, “erg/cm²”, “erg/cm^2”
+    erg per square millimeter:  “erg per square millimeter”, “erg/mm²”, “erg/mm^2”
+    joule per square meter:  “joule per square meter”, “j/m²”, “j/m^2”
+
+Pressure:
+    Pascal:  “Pascal”, “Pa”
+    kiloPascal:  “kiloPascal”, “kPa”
+    megaPascal:  “megaPascal”, “MPa”
+    Newton per square meter:  “Newton per square meter”, “N/m²”, “N/m^2”
+    bar:  “bar”, 
+    millibar:  “millibar”, “mbar”
+    dyne per square centimeter:  “dyne per square centimeter”, “dyn/cm²”, “dyn/cm^2”
+    pound per square inch:  “pound per square inch”, “lb/in²”, “lb/in^2”, “psi”
+
+Concentration In Water:
+    kilogram per cubic meter:  “kilogram per cubic meter”, “kg/m³”, “kg/m^3”
+    gram per cubic meter:  “gram per cubic meter”, “g/m³”, “g/m^3”
+    part per million:  “part per million”, “ppm”, “parts per million”
+    part per billion:  “part per billion”, “ppb”, “parts per billion”
+    part per thousand:  “part per thousand”, “‰”, “0/00”, “ppt”, “parts per thousand”
+    part per trillion:  “part per trillion”, “pptr”, “parts per trillion”
+    fraction (decimal):  “fraction (decimal)”, “fraction”, “mass per mass”, “1”
+    percent:  “percent”, “%”, “parts per hundred”
+    pound per cubic foot:  “pound per cubic foot”, “lb/ft³”, “lb/ft^3”
+    milligram per liter:  “milligram per liter”, “mg/l”
+    gram per liter:  “gram per liter”, “g/l”
+    kilogram per liter:  “kilogram per liter”, “kg/l”
+    milligram per gram:  “milligram per gram”, “mg/g”
+    milligram per kilogram:  “milligram per kilogram”, “mg/kg”
+    milligram per milliliter:  “milligram per milliliter”, “mg/ml”
+    microgram per liter:  “microgram per liter”, “µg/l”, “ug/l”
+    microgram per gram:  “microgram per gram”, “µg/g”, “ug/g”
+    nanogram per liter:  “nanogram per liter”, “ng/l”
+
+Concentration:
+    fraction (decimal):  “fraction (decimal)”, “fraction”, “mass per mass”, “1”
+    percent:  “percent”, “%”, “parts per hundred”
+    part per thousand:  “part per thousand”, “‰”, “0/00”, “parts per thousand”
+    part per million:  “part per million”, “ppm”, “parts per million”
+    part per billion:  “part per billion”, “ppb”, “parts per billion”
+    part per trillion:  “part per trillion”, “parts per trillion”
+
+Dimensionless:
+    fraction (decimal):  “fraction (decimal)”, “number”, “fraction”, “1”
+    percent:  “percent”, “%”, “parts per hundred”
+    part per thousand:  “part per thousand”, “‰”, “0/00”, “ppt”, “parts per thousand”
+    part per million:  “part per million”, “ppm”, “parts per million”
+    part per billion:  “part per billion”, “ppb”, “parts per billion”
+
+Mass Fraction:
+    fraction (decimal):  “fraction (decimal)”, “fraction”, “1”, “mass per mass”
+    percent:  “percent”, “%”, “parts per hundred”
+    part per thousand:  “part per thousand”, “‰”, “0/00”, “ppt”, “parts per thousand”
+    part per million:  “part per million”, “ppm”, “parts per million”
+    part per billion:  “part per billion”, “ppb”, “parts per billion”
+    part per trillion:  “part per trillion”, “parts per trillion”
+    gram per kilogram:  “gram per kilogram”, “g/kg”
+    milligram per gram:  “milligram per gram”, “mg/g”
+    milligram per kilogram:  “milligram per kilogram”, “mg/kg”
+    microgram per gram:  “microgram per gram”, “µg/g”, “ug/g”
+    nanogram per gram:  “nanogram per gram”, “ng/g”, “nanograms per gram”
+
+Volume Fraction:
+    fraction (decimal):  “fraction (decimal)”, “fraction”, “1”, “mass per mass”
+    percent:  “percent”, “%”, “parts per hundred”
+    part per thousand:  “part per thousand”, “‰”, “0/00”, “ppt”, “parts per thousand”
+    part per million:  “part per million”, “ppm”, “parts per million”
+    part per billion:  “part per billion”, “ppb”, “parts per billion”
+    part per trillion:  “part per trillion”, “pptril”, “parts per trillion”
+    milliliter per liter:  “milliliter per liter”, “ml/l”, “mL/dm^3”
+    liter per cubic meter:  “liter per cubic meter”, “l/m^3”
+
+Angular Measure:
+    radian:  “radian”, “rad”, “radians”
+    degree:  “degree”, “deg”, “degrees”
+
+Angular Velocity:
+    rad/s:  “rad/s”, “1/s”, “radians/sec”
+    hertz:  “hertz”, “hz”, “cycles/sec”
+    rotations per minute:  “rotations per minute”, “rpm”

nucos/__init__.py

@@ -23,6 +23,7 @@
                               is_supported,
                               is_supported_unit,
                               get_supported_names,
+                              get_unit_type,
                               get_unit_types,
                               get_primary_name,
                               get_primary_names,

nucos/tests/test_unit_conversion.py

@@ -709,3 +709,19 @@ def test_get_primary_names_with_space():
     assert set(result) == {'gram per second', 'kilogram per second'}
 
 
+def test_get_unit_type():
+    """
+    not much, but something
+    """
+    unit_type = unit_conversion.get_unit_type('m/s')
+
+    assert unit_type == "velocity"
+
+def test_get_unit_type_bad():
+    """
+    not much, but something
+    """
+    with pytest.raises(unit_conversion.NotSupportedUnitError):
+        unit_type = unit_conversion.get_unit_type('fred')
+
+

nucos/unit_conversion.py

@@ -76,6 +76,27 @@ def GetUnitTypes():
     return list(ConvertDataUnits.keys())
 
 
+def get_unit_type(unit):
+    """
+    Return the unit type for a given unit name.
+
+    Note that this will only work for unambiguous units
+
+    :param unit: the unit you want the type of
+    :type unit: str
+
+    In [2]: nucos.get_unit_type('meter')
+    Out[2]: 'length'
+    """
+    unit = Simplify(unit)
+
+    try:
+        unit_type = UNIT_TYPES[unit]
+    except KeyError:
+        raise NotSupportedUnitError(unit)
+    return unit_type
+
+
 def get_unit_types():
     return list(PRETTY_UNIT_TYPES.values())