Metadata-Version: 2.1
Name: PH-units
Version: 1.4.1
Summary: Tools for working with common Passive House unit types
Home-page: https://github.com/PH-Tools/PH_units
Author: PH-Tools
Author-email: phtools@bldgtyp.com
License: GPLv3+
Description: # PH-Units:
        A package for converting common Passive House unit types (IP | SI).
        
        ## Usage:
        The most basic usage is a simple conversion from one known unit to another:
        ```python
        >>> from ph_units.converter import convert
        >>> # Convert 12.45 meters to feet...
        >>> convert(12.45, "M", "FT") -> 40.85 # FT
        ```
        
        
        The package also has a parser which can take simple text in the format: `"{value} {unit}"` and will split apart the text into a numeric part and a unit part:
        ```python
        >>> from ph_units.parser import parse_input
        >>> val, unit = parse_input("0.17 BTU/HR-FT2-F")
        >>> val  # 0.17
        >>> unit # 'BTU/HR-FT2-F'
        ```
        The results of the parser can then be fed into the converter
        ```
        >>> from ph_units.converter import convert
        >>> convert(val, "W/MK", unit) -> 0.098 # BTU/HR-FT2-F
        ```
        
        - - -
        ## Unit Types Supported:
        * Length (m, cm, mm, in, ft)
        * Area (m2, ft2)
        * volume (m2, ft3, liters, gallons)
        * energy (Wh/M3, Wh/M2, kW/M2, kBtu/ft2, Btu/ft2)
        * power (kW, W, W/M2, W/ft2, W/cfm, Btu/h-ft2, Btu/h)
        * speed (m/d, m/s, m/h, ft/s, ft/d)
        * temperature (C, F)
        * volume flow (m3/hr, cfm)
        
         - - -
         ## Adding New Units:
         The conversion factors used are stored as types in the [`ph_units.unit_types`](https://github.com/PH-Tools/PH_units/tree/main/ph_units/unit_types) directory. Note that the types also allow for common 'alias' descriptions ie: 'feet' can be denoted as "FT", "ft." or even the symbol '
        
        - - - 
        ![Tests](https://github.com/PH-Tools/PHX/actions/workflows/ci.yaml/badge.svg )
        ![versions](https://img.shields.io/pypi/pyversions/pybadges.svg)
        [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Description-Content-Type: text/markdown
