Metadata-Version: 2.1
Name: joulescope
Version: 0.4.3
Summary: Joulescope™ host driver and utilities
Home-page: https://www.joulescope.com
Author: Jetperch LLC
Author-email: joulescope-dev@jetperch.com
License: Apache
Project-URL: Bug Reports, https://github.com/jetperch/pyjoulescope/issues
Project-URL: Funding, https://www.joulescope.com
Project-URL: Twitter, https://twitter.com/joulescope
Project-URL: Source, https://github.com/jetperch/pyjoulescope/
Description: 
        # Joulescope
        
        Welcome to Joulescope™!  Joulescope is an affordable, precision DC energy 
        analyzer that enables you to build better products. 
        Joulescope™ accurately and simultaneously measures the voltage and current 
        supplied to your target device, and it then computes power and energy. 
        For more information on Joulescope, see 
        [www.joulescope.com](https://www.joulescope.com).
        
        This pyjoulescope python package contains the driver and command-line 
        utilities that  run on a host computer and communicates with a Joulescope 
        device over USB. You can use this package to automate and script Joulescope 
        operation. You can also incorporate Joulescope into a custom application.
        Most users will run the graphical user interface which is in the 
        [pyjoulescope_ui](https://github.com/jetperch/pyjoulescope_ui) package. 
        The majority of code is written in Python 3.6+, but a small amount is in 
        Cython for better performance. 
        
        This package runs under Windows 10, Linux (Ubuntu is tested) and Mac OS X.
        On Windows, the USB communication is performed using 
        [WinUSB](https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/winusb),
        which is included with Windows 10.
        On Linux and Mac OS X, the USB communication uses 
        [libusb-1.0](https://libusb.info/).
        
        For the list of changes by release, see the [Changelog](CHANGELOG.md).
        
        If you just want to use Joulescope, you can 
        [download](https://www.joulescope.com/download) the application.
        
        
        ## Developer
        
        Install [Python](https://www.python.org/) 3.6+. 
        
        
        ### Configure virtualenv
        
        Although not required, the developers recommend using 
        [virtualenv](https://virtualenv.pypa.io/en/latest/).
        
        First install virtualenv:
        
            pip3 install virtualenv
            
        And then create a new virtual environment.
        
            virtualenv ~/venv/joulescope
        
        You need to activate the virtual environment whenever you start
        a new terminal.
            
        On POSIX (Linux, Mac OS X with homebrew):
        
            source ~/venv/joulescope/bin/activate
            
        On Windows:
        
            virtualenv c:\venv\joulescope
            source c:\venv\joulescope\Scripts\activate
        
        ### Configure packages
            
        Install development dependencies:
        
            pip3 install -r requirements.txt
        
        
        ### Use Joulescope
            
        Joulescope includes PYX files that must be compiled to native libraries using
        Cython. You can use the setup script to allow development in place:
        
            python3 setup.py build_ext --inplace
            
        You should then be able to execute joulescope:
        
            python3 -m joulescope --help
            
        If you would rather build and install Joulescope:
        
            python setup.py sdist
            pip3 install dist/joulescope_[version].tar.gz
        
        
        ## License
        
        All pyjoulescope code is released under the permissive Apache 2.0 license.
        See the [License File](LICENSE.txt) for details.
        
Keywords: joulescope driver
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
