Metadata-Version: 1.1
Name: PyResistorColorCode
Version: 1.0.0
Summary: Python module providing some tools to manage IEC 60062 marking codes for resistors.
Home-page: https://github.com/FabriceSalvaire/PyResistorColorCode
Author: Fabrice Salvaire
Author-email: fabrice.salvaire@orange.fr
License: GPLv3
Description-Content-Type: UNKNOWN
Description: .. -*- Mode: rst -*-
        
        =====================
         PyResistorColorCode
        =====================
        
        The user and API documentation is hosted on the project `homepage <http://fabricesalvaire.github.io/PyResistorColorCode>`_.
        
        Written by Fabrice Salvaire
        
        ==========
         Overview
        ==========
        
        .. -*- Mode: rst -*-
        
        PyResistorColorCode is a Python module that provides some tools to manage `IEC 60062
        <http://webstore.iec.ch/webstore/webstore.nsf/artnum/033377!openDocument>`_ marking codes for
        resistors.
        
        .. IEC 60062 is also for "and capacitors"
        
        The associated program **resistor-decoder** provides a graphical user interface to help user to
        decode a resistor colour-coding using an inference algorithm. This feature is an enhancement
        compared to a program like **gresistor** which is only a colour-coding calculator.
        
        I started to develop this software a day where I had to sort a lot of unsorted resistors in a
        jumble. Resistors colour-coding using no more than 3 bands (2 digits and a multiplier) are no too
        difficult to decode when a person is experienced. But for more accurate resistors, it is more
        tricky. Another difficulty arises when it is difficult to recognise the colour of a band, due to an
        inappropriate colour contrast or tone. For strange colour-coding we can in last resort use an
        Ohmmeter to measure the resistance value. But it doesn't respond to the question what is the
        specification of this resistor: tolerance, temperature coefficient, etc. For all theses reasons, I
        developed an inference algorithm coupled to an graphical user interface to help user to decode
        resistor colour-coding.
        
        .. End
        
        .. The user and API documentation is hosted `here <http://fabricesalvaire.github.io/PyResistorColorCode>`_.
        
        .. image:: https://raw.github.com/FabriceSalvaire/PyResistorColorCode/master/doc/sphinx/source/images/resistor-decoder.png
        
        Inference Algorithm
        -------------------
        
        .. -*- Mode: rst -*-
        
        The inference algorithm works as follow:
        
        * code orientation (left-right or right-left) doesn't matter,
        * unset bands are not take into account,
        * at least 3 colours must be provided: 2 digits and the multiplier,
        * colour band are interpreted by priority as:
        
         #. resistance value,
         #. resistance tolerance,
         #. temperature coefficient,
        
        * the resistance value must exists in a IEC 60063 series: E6, E12, E48, E96, E192,
        * the resistance tolerance must be defined if there is a colour band assigned to it. 
        
        When there is more than one hypothesis for the given input, the hypotheses are sorted by ascending
        precision (series).
        
        .. End
        
        .. -*- Mode: rst -*-
        
        .. Global Definitions
        
        .. |github| image:: /images/GitHub_Logo.png
           :alt: GitHub logo
           :height: 20
        
        .. |ohloh| image:: https://www.ohloh.net/accounts/230426/widgets/account_tiny.gif
           :target: https://www.ohloh.net/accounts/fabricesalvaire
           :alt: Fabrice Salvaire's Ohloh profile
           :height: 15px
           :width:  80px
        
        .. End
        
        ==============
         Installation
        ==============
        
        You can install from `Pypy <https://pypi.python.org/pypi/PyResistorColorCode>`_::
        
          pip install PyResistorColorCode
        
        but pip is unable to install `PyQt <http://www.riverbankcomputing.co.uk/software/pyqt/intro>`_. If
        you are on Linux then install the corresponding package else download the installer from `PyQt
        download page <http://www.riverbankcomputing.co.uk/software/pyqt/download>`_.
        
        Source Repository
        -----------------
        
        The source code is licensed under GPL V3 and is hosted on `GitHub
        <https://github.com/FabriceSalvaire/PyResistorColorCode>`_.  Also a Python package is available on `PyPI
        <http://pypi.python.org/pypi/PyResistorColorCode>`_. And the relative project page on |ohloh| is
        located on the `ohloh project page <https://www.ohloh.net/p/PyResistorColorCode>`_.
        
        Requirements
        ------------
        
        * Python 2.7
        * PyQt 4.8
        
        Manual Installation
        -------------------
        
        Alternatively you can download the source from Github or Pypi and run the following commands in a
        terminal within the source directory::
        
          python setup.py build
          python setup.py install
        
        Running
        -------
        
        Set the terminal environment using::
        
          source setenv.sh
        
        then run the command::
        
          bin/resistor-decoder
        
        Package for Linux
        -----------------
        
        RPM *.spec* files are provided for Fedora (up to F18), see *spec* directory in the sources.
        
        .. End
        
        .. End
        
Keywords: resistor color colour code IEC 6006
Platform: any
Classifier: Topic :: Scientific/Engineering
Classifier: Intended Audience :: Education
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.0
