Metadata-Version: 1.1
Name: phriky-units
Version: 0.1.39
Summary: Physical unit static analysis tool for C++ +
Home-page: https://github.com/jpwco/phriky_units
Author: John-Paul Ore
Author-email: jore@cse.unl.edu
License: MIT license
Description: ## Phriky Units - Physical Unit Inconsistency Detection
        
        Physical unit static analysis tool for <a href='http://www.ros.org'>ROS</a> C++.
        
        WINNER: <a href="https://conf.researchr.org/home/issta-2017">ISSTA 2017 Best Tool Demonstration</a>
        
        <a href='https://unl.box.com/shared/static/83mnbe7ez73z5az7ct5gbabo1wm9htfl.ova'>ARTIFACT -- Download Virtual Machine with phriky-units pre-installed (Ubuntu 16.04 VM 3 GB .ova).</a>
        
        <a href="https://youtu.be/cc-Bubopml4" target="_blank"><img src="./.youtube.png" width="420" alt="youtbe screenshot for Phriky-Units"></a>
        
        \* Free software: MIT license .. \*Lightweight static analysis Lightweight static analysis 
        
        ## Install (tested on Ubuntu 16.04 and OSX 10.12.6)
        
        `pip install phriky_units`
        
        **Requires Cppcheck greater than 1.75:**
        
        `apt-get install cppcheck` (Ubuntu 16.04)
          
        `brew install cppcheck` (OSX)
          
        `git clone git://github.com/danmar/cppcheck.git` (Ubuntu 14.04)
        
        
        Examples:
        =========
        
        You can run examples by checking out:
        
        `git clone https://github.com/unl-nimbus-lab/phriky-units.git`
        
        Then from that directory run:
        
        `phriky_units ./examples/addition/src/action.cpp`
        
        `phriky_units ./examples/assignment/src/trajectory_planner_ros.cpp`
        
        `phriky_units ./examples/comparison/src/twist_marker.cpp`
        
        Features
        ========
        
        -   Detects physical unit inconsistencies, like adding quantities with different units, i.e. `meters` + `seconds`.
        -   Lightweight static analysis
        -   Path insensitive
        -   No annotation burden
        -   Low false positive rate (&lt; 15% for \`high-confidence’ inconsistencies)
        -   Works with [ROS]
        
        Credits
        =======
        
        [NIMBUS] Lab at the University of Nebraska, Lincoln
        
        This work was supported in part by NSF awards \#1638099 and \#1526652, and USDA-NIFA \#2013-67021-20947.
        
          [ROS]: http://www.ros.org
          [NIMBUS]: http://nimbus.unl.edu
        
        
        =======
        History
        =======
        
        0.1.0 (2016-08-31)
        ------------------
        
        * First release on PyPI.
        
Keywords: phriky_units
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
