Metadata-Version: 1.1
Name: undervolt
Version: 0.1.3
Summary: Undervolt Intel CPUs under Linux
Home-page: http://github.com/georgewhewell/undervolt
Author: George Whewell
Author-email: georgerw@gmail.com
License: GPL
Description-Content-Type: UNKNOWN
Description: *Warning!*
        
        *This program is untested (apart from by myself) and it may damage your hardware! Use at your own risk.*
        
        =========
        undervolt
        =========
        
        *undervolt* is a program for undervolting Intel CPUs under Linux. It works in
        a similar manner to the Windows program *ThrottleStop* (i.e, `MSR 0x150`). You
        can apply a fixed voltage offset to one of 5 voltage planes.
        
        For more information, read
        `here <https://github.com/mihic/linux-intel-undervolt>`_.
        
        Installing
        ----------
        
        From PyPi::
        
            $ pip install undervolt
        
        From source::
        
            $ git clone https://github.com/georgewhewell/undervolt.git
        
        Examples
        --------
        
        Read current offsets::
        
            $ undervolt --read
            core: 0.0 mV
            gpu: -19.53 mV
            cache: -30.27 mV
            uncore: -29.3 mV
            analogio: -70.31 mV
        
        Apply -100mV offset to CPU Core and Cache::
        
            $ undervolt --core -100 --cache -100
        
        Apply -75mV offset to GPU, -100mV to all other planes::
        
            $ undervolt --gpu -75 --core -100 --cache -100 --uncore -100 --analogio -100
        
        Usage
        -----
        
        .. code-block:: bash
        
            $ undervolt -h
            usage: undervolt [-h] [-v] [-f] [--core CORE] [--gpu GPU] [--cache CACHE]
                             [--uncore UNCORE] [--analogio ANALOGIO]
            optional arguments:
              -h, --help            show this help message and exit
              -v, --verbose         print debug info
              -f, --force           allow setting positive offsets
              -r, --read            read existing values
              --core CORE           offset (mV)
              --gpu GPU             offset (mV)
              --cache CACHE         offset (mV)
              --uncore UNCORE       offset (mV)
              --analogio ANALOGIO   offset (mV)
        
        Hardware support
        ----------------
        
        Undervolting should work on any CPU later then Haswell.
        
        ===================== ========= ==========
              System             CPU     Working?
        ===================== ========= ==========
        Lenovo X1 Yoga Gen 2  i7-7600U  Yes
        ===================== ========= ==========
        
        Credit
        ------
        This project is trivial wrapper around the work of others from the following resources:
        
        - https://github.com/mihic/linux-intel-undervolt
        - http://forum.notebookreview.com/threads/undervolting-e-g-skylake-in-linux.807953
        - https://forums.anandtech.com/threads/what-controls-turbo-core-in-xeons.2496647
        
        Many thanks to all who contributed.
        
Keywords: undervolt,intel,linux
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
