Metadata-Version: 1.1
Name: nidmm
Version: 0.1.dev1
Summary: NI-DMM Python API
Home-page: https://github.com/ni/nimi-python
Author: National Instruments
Author-email: opensource@ni.com
License: MIT
Description: ===========  =================================================================================================================
        Info         Python bindings for NI Modular Instrument drivers. See `GitHub <https://github.com/ni/nimi-python/>`_ for the latest source.
        Author       National Instruments
        ===========  =================================================================================================================
        
        
        .. warning::
           NI Modular Instruments Python API is currently under development. You are welcome to use it,
           and we welcome feedback, but be prepared for changes to the APIs.
        
        .. _about-section:
        
        About
        =====
        
        The **nimi-python** repository generates Python bindings (Application Programming Interface) for interacting with the Modular Instrument drivers. Currently, the following drivers are supported:
        
        * NI-DMM (Python module: nidmm)
        
        It is implemented as a set of `Mako templates <http://makotemplates.org>`_ and per-driver metafiles that produce a Python module for each driver. The driver is called through its public C API using the
        `ctypes <https://docs.python.org/2/library/ctypes.html>`_ Python library.
        
        **nimi-python** supports only the Windows operating system.
        
        ** nimi-python** supports CPython 3.6+. * TODO(marcoskirsch): Add PyPI version here.*
        
        .. _installation-section:
        
        Installation
        ============
        
        In order to use nimi-python modules, you must install the corresponding driver runtime on your system. Visit `ni.com/downloads <http://www.ni.com/downloads/>`_ to download the latest driver version for your devices.
        
        Specific Python bindings (i.e. for **NI-DMM**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::
        
          $ python -m pip install nidmm
        
        Or **easy_install** from
        `setuptools <http://pypi.python.org/pypi/setuptools>`_::
        
          $ python -m easy_install nidmm
        
        You also can download the project source, build, and run::
        
          $ python TODO(marcoskirsch): how do we build?
          $ python setup.py install
        
        .. _usage-section:
        
        Usage
        =====
        
        The following is a basic example of using the **nidmm** module to open a session to a DMM and perform a 5.5 digits of resolution voltage measurement in the 10 V range.
        
        .. code-block:: python
        
            import nidmm
            with nidmm.Session("Dev1") as session:
                session.configureMeasurementDigits(nidmm.Function.DC_VOLTS, 10, 5.5)
                print("Measurement: " + str(session.read()))
        
        .. _support-section:
        
        Support / Feedback
        ==================
        
        The packages included in **nimi-python** package are supported by NI. For support, open
        a request through the NI support portal at `ni.com <http://www.ni.com>`_.
        
        .. _bugs-section:
        
        Bugs / Feature Requests
        =======================
        
        To report a bug or submit a feature request, please use the
        `GitHub issues page <https://github.com/ni/nimi-python/issues>`_.
        
        Information to Include When Asking for Help
        -------------------------------------------
        
        Please include **all** of the following information when opening an issue:
        
        - Detailed steps on how to reproduce the problem and full traceback, if
          applicable. Code samples are encouraged!
        
        - The python version used::
        
          $ python -c "import sys; print(sys.version)"
        
        - The module (i.e. **nidmm**) and its version::
        
          $ python -m pip list
        
        - The version of the driver used (i.e. **NI-DMM 17.1**). Follow
          `this KB article <http://digital.ni.com/express.nsf/bycode/ex8amn>`_
          to determine the version you have installed.
        
        - The operating system, version, and bitness. For example 64-bit Windows 7.
        
        .. _documentation-section:
        
        Documentation
        =============
        
        Documentation is available `here <http://nimi-python.readthedocs.io>`_.
        
        Additional Documentation
        ========================
        
        Refer to your driver documentation for device-specific information and detailed API documentation.
        
        .. _license-section:
        
        License
        =======
        
        **nimi-python** is licensed under an MIT-style license (see
        `LICENSE <https://github.com/ni/nimi-python/blob/master/LICENSE>`_).
        Other incorporated projects may be licensed under different licenses. All
        licenses allow for non-commercial and commercial use.
        
        
Keywords: nidmm
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: System :: Hardware :: Hardware Drivers
