Overall Status
--------------
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| master branch status | |BuildStatus| |MITLicense| |CoverageStatus| |
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| GitHub status | |OpenIssues| |OpenPullRequests| |
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
=========== ============================================================================================================================
Info Python bindings for NI Modular Instrument drivers. See `GitHub <https://github.com/ni/nimi-python/>`_ for the latest source.
Author NI
=========== ============================================================================================================================
.. |BuildStatus| image:: https://api.travis-ci.com/ni/nimi-python.svg
:alt: Build Status - master branch
:target: https://travis-ci.org/ni/nimi-python
.. |MITLicense| image:: https://img.shields.io/badge/License-MIT-yellow.svg
:alt: MIT License
:target: https://opensource.org/licenses/MIT
.. |CoverageStatus| image:: https://codecov.io/github/ni/nimi-python/graph/badge.svg
:alt: Test Coverage - master branch
:target: https://codecov.io/github/ni/nimi-python
.. |OpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python.svg
:alt: Open Issues + Pull Requests
:target: https://github.com/ni/nimi-python/issues
.. |OpenPullRequests| image:: https://img.shields.io/github/issues-pr/ni/nimi-python.svg
:alt: Open Pull Requests
:target: https://github.com/ni/nimi-python/pulls
.. _about-section:
About
=====
The **nifgen** module provides a Python API for NI-FGEN. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.
Support Policy
--------------
**nifgen** supports all the Operating Systems supported by NI-FGEN.
It follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.
NI-FGEN Python API Status
-------------------------
+-------------------------------+-----------------------+
| NI-FGEN (nifgen) | |
+===============================+=======================+
| Driver Version Tested Against | 2023 Q4 |
+-------------------------------+-----------------------+
| PyPI Version | |nifgenLatestVersion| |
+-------------------------------+-----------------------+
| Supported Python Version | |nifgenPythonVersion| |
+-------------------------------+-----------------------+
| Documentation | |nifgenDocs| |
+-------------------------------+-----------------------+
| Open Issues | |nifgenOpenIssues| |
+-------------------------------+-----------------------+
| Open Pull Requests | |nifgenOpenPRs| |
+-------------------------------+-----------------------+
.. |nifgenLatestVersion| image:: http://img.shields.io/pypi/v/nifgen.svg
:alt: Latest NI-FGEN Version
:target: http://pypi.python.org/pypi/nifgen
.. |nifgenPythonVersion| image:: http://img.shields.io/pypi/pyversions/nifgen.svg
:alt: NI-FGEN supported Python versions
:target: http://pypi.python.org/pypi/nifgen
.. |nifgenDocs| image:: https://readthedocs.org/projects/nifgen/badge/?version=latest
:alt: NI-FGEN Python API Documentation Status
:target: https://nifgen.readthedocs.io/en/latest
.. |nifgenOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nifgen.svg
:alt: Open Issues + Pull Requests for NI-FGEN
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anifgen
.. |nifgenOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nifgen.svg
:alt: Pull Requests for NI-FGEN
:target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anifgen
.. _nifgen_installation-section:
Installation
------------
As a prerequisite to using the **nifgen** module, you must install the NI-FGEN runtime on your system. Visit `ni.com/downloads <http://www.ni.com/downloads/>`_ to download the driver runtime for your devices.
The nimi-python modules (i.e. for **NI-FGEN**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::
$ python -m pip install nifgen~=1.4.8
Contributing
============
We welcome contributions! You can clone the project repository, build it, and install it by `following these instructions <https://github.com/ni/nimi-python/blob/master/CONTRIBUTING.md>`_.
Usage
------
The following is a basic example of using the **nifgen** module to open a session to a Function Generator and generate a sine wave for 5 seconds.
.. code-block:: python
import nifgen
import time
with nifgen.Session("Dev1") as session:
session.output_mode = nifgen.OutputMode.FUNC
session.configure_standard_waveform(waveform=nifgen.Waveform.SINE, amplitude=1.0, frequency=10000000, dc_offset=0.0, start_phase=0.0)
with session.initiate():
time.sleep(5)
`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/nifgen/examples>`_
.. _support-section:
Support / Feedback
==================
For support specific to the Python API, follow the processs in `Bugs / Feature Requests`_.
For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums <https://forums.ni.com/>`_.
.. _bugs-section:
Bugs / Feature Requests
=======================
To report a bug or submit a feature request specific to Python API, please use the
`GitHub issues page <https://github.com/ni/nimi-python/issues>`_.
Fill in the issue template as completely as possible and we will respond as soon
as we can.
.. _documentation-section:
Documentation
=============
Documentation is available `here <http://nifgen.readthedocs.io>`_.
.. _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.
**gRPC Features**
For driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to Session.__init__() is
subject to the NI General Purpose EULA (`see NILICENSE <https://github.com/ni/nimi-python/blob/master/NILICENSE>`_).
Raw data
{
"_id": null,
"home_page": "https://github.com/ni/nimi-python",
"name": "nifgen",
"maintainer": "NI",
"docs_url": null,
"requires_python": null,
"maintainer_email": "opensource@ni.com",
"keywords": "nifgen",
"author": "NI",
"author_email": "opensource@ni.com",
"download_url": "https://files.pythonhosted.org/packages/3b/ad/6fa00aca8f9f3458896c6701e6213c0e3006de4c50b6afcbc6deaa52fba9/nifgen-1.4.8.tar.gz",
"platform": null,
"description": "Overall Status\n--------------\n\n+----------------------+------------------------------------------------------------------------------------------------------------------------------------+\n| master branch status | |BuildStatus| |MITLicense| |CoverageStatus| |\n+----------------------+------------------------------------------------------------------------------------------------------------------------------------+\n| GitHub status | |OpenIssues| |OpenPullRequests| |\n+----------------------+------------------------------------------------------------------------------------------------------------------------------------+\n\n=========== ============================================================================================================================\nInfo Python bindings for NI Modular Instrument drivers. See `GitHub <https://github.com/ni/nimi-python/>`_ for the latest source.\nAuthor NI\n=========== ============================================================================================================================\n\n.. |BuildStatus| image:: https://api.travis-ci.com/ni/nimi-python.svg\n :alt: Build Status - master branch\n :target: https://travis-ci.org/ni/nimi-python\n\n.. |MITLicense| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :alt: MIT License\n :target: https://opensource.org/licenses/MIT\n\n.. |CoverageStatus| image:: https://codecov.io/github/ni/nimi-python/graph/badge.svg\n :alt: Test Coverage - master branch\n :target: https://codecov.io/github/ni/nimi-python\n\n.. |OpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python.svg\n :alt: Open Issues + Pull Requests\n :target: https://github.com/ni/nimi-python/issues\n\n.. |OpenPullRequests| image:: https://img.shields.io/github/issues-pr/ni/nimi-python.svg\n :alt: Open Pull Requests\n :target: https://github.com/ni/nimi-python/pulls\n\n\n.. _about-section:\n\nAbout\n=====\n\nThe **nifgen** module provides a Python API for NI-FGEN. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.\n\nSupport Policy\n--------------\n**nifgen** supports all the Operating Systems supported by NI-FGEN.\n\nIt follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.\n\n\nNI-FGEN Python API Status\n-------------------------\n\n+-------------------------------+-----------------------+\n| NI-FGEN (nifgen) | |\n+===============================+=======================+\n| Driver Version Tested Against | 2023 Q4 |\n+-------------------------------+-----------------------+\n| PyPI Version | |nifgenLatestVersion| |\n+-------------------------------+-----------------------+\n| Supported Python Version | |nifgenPythonVersion| |\n+-------------------------------+-----------------------+\n| Documentation | |nifgenDocs| |\n+-------------------------------+-----------------------+\n| Open Issues | |nifgenOpenIssues| |\n+-------------------------------+-----------------------+\n| Open Pull Requests | |nifgenOpenPRs| |\n+-------------------------------+-----------------------+\n\n\n.. |nifgenLatestVersion| image:: http://img.shields.io/pypi/v/nifgen.svg\n :alt: Latest NI-FGEN Version\n :target: http://pypi.python.org/pypi/nifgen\n\n\n.. |nifgenPythonVersion| image:: http://img.shields.io/pypi/pyversions/nifgen.svg\n :alt: NI-FGEN supported Python versions\n :target: http://pypi.python.org/pypi/nifgen\n\n\n.. |nifgenDocs| image:: https://readthedocs.org/projects/nifgen/badge/?version=latest\n :alt: NI-FGEN Python API Documentation Status\n :target: https://nifgen.readthedocs.io/en/latest\n\n\n.. |nifgenOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nifgen.svg\n :alt: Open Issues + Pull Requests for NI-FGEN\n :target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anifgen\n\n\n.. |nifgenOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nifgen.svg\n :alt: Pull Requests for NI-FGEN\n :target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anifgen\n\n\n\n.. _nifgen_installation-section:\n\nInstallation\n------------\n\nAs a prerequisite to using the **nifgen** module, you must install the NI-FGEN runtime on your system. Visit `ni.com/downloads <http://www.ni.com/downloads/>`_ to download the driver runtime for your devices.\n\nThe nimi-python modules (i.e. for **NI-FGEN**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::\n\n $ python -m pip install nifgen~=1.4.8\n\n\nContributing\n============\n\nWe welcome contributions! You can clone the project repository, build it, and install it by `following these instructions <https://github.com/ni/nimi-python/blob/master/CONTRIBUTING.md>`_.\n\nUsage\n------\n\nThe following is a basic example of using the **nifgen** module to open a session to a Function Generator and generate a sine wave for 5 seconds.\n\n.. code-block:: python\n\n import nifgen\n import time\n with nifgen.Session(\"Dev1\") as session:\n session.output_mode = nifgen.OutputMode.FUNC\n session.configure_standard_waveform(waveform=nifgen.Waveform.SINE, amplitude=1.0, frequency=10000000, dc_offset=0.0, start_phase=0.0)\n with session.initiate():\n time.sleep(5)\n\n`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/nifgen/examples>`_\n\n.. _support-section:\n\nSupport / Feedback\n==================\n\nFor support specific to the Python API, follow the processs in `Bugs / Feature Requests`_.\nFor support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums <https://forums.ni.com/>`_.\n\n.. _bugs-section:\n\nBugs / Feature Requests\n=======================\n\nTo report a bug or submit a feature request specific to Python API, please use the\n`GitHub issues page <https://github.com/ni/nimi-python/issues>`_.\n\nFill in the issue template as completely as possible and we will respond as soon\nas we can.\n\n\n.. _documentation-section:\n\nDocumentation\n=============\n\nDocumentation is available `here <http://nifgen.readthedocs.io>`_.\n\n\n.. _license-section:\n\nLicense\n=======\n\n**nimi-python** is licensed under an MIT-style license (`see\nLICENSE <https://github.com/ni/nimi-python/blob/master/LICENSE>`_).\nOther incorporated projects may be licensed under different licenses. All\nlicenses allow for non-commercial and commercial use.\n\n\n**gRPC Features**\n\nFor driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to Session.__init__() is\nsubject to the NI General Purpose EULA (`see NILICENSE <https://github.com/ni/nimi-python/blob/master/NILICENSE>`_).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "NI-FGEN Python API",
"version": "1.4.8",
"project_urls": {
"Homepage": "https://github.com/ni/nimi-python"
},
"split_keywords": [
"nifgen"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d5cc5475215984c2fca86a089c508ff6fa6d2a916a0de6cb1f2999a5d2f3d6a",
"md5": "f92ad54b1e0114298e9a8f8eefe18fcf",
"sha256": "e256e6a09af5d2e20ed0819f008a0b115f5d0c435847bfd021060308346e54e9"
},
"downloads": -1,
"filename": "nifgen-1.4.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f92ad54b1e0114298e9a8f8eefe18fcf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 96414,
"upload_time": "2024-04-26T20:12:10",
"upload_time_iso_8601": "2024-04-26T20:12:10.388929Z",
"url": "https://files.pythonhosted.org/packages/0d/5c/c5475215984c2fca86a089c508ff6fa6d2a916a0de6cb1f2999a5d2f3d6a/nifgen-1.4.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bad6fa00aca8f9f3458896c6701e6213c0e3006de4c50b6afcbc6deaa52fba9",
"md5": "6af51ab6c0b7cd78ba1e49bc678749ca",
"sha256": "80edf6f36b6df1c4395637faf050c7e16c55b84f9f1f14ca6736c2dc28a51f10"
},
"downloads": -1,
"filename": "nifgen-1.4.8.tar.gz",
"has_sig": false,
"md5_digest": "6af51ab6c0b7cd78ba1e49bc678749ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 94397,
"upload_time": "2024-04-26T20:12:26",
"upload_time_iso_8601": "2024-04-26T20:12:26.974402Z",
"url": "https://files.pythonhosted.org/packages/3b/ad/6fa00aca8f9f3458896c6701e6213c0e3006de4c50b6afcbc6deaa52fba9/nifgen-1.4.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 20:12:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ni",
"github_project": "nimi-python",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "nifgen"
}
JSON
