Overall Status
--------------
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| master branch status | |BuildStatus| |MITLicense| |CoverageStatus| |
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| GitHub status | |OpenIssues| |OpenPullRequests| |
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
=========== ============================================================================================================================
Info NI Modular Instrument driver APIs for Python.
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 **nirfsg** module provides a Python API for NI-RFSG. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.
Support Policy
--------------
**nirfsg** supports all the Operating Systems supported by NI-RFSG.
It follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.
NI created and supports **nirfsg**.
NI-RFSG Python API Status
-------------------------
+-------------------------------+-----------------------+
| NI-RFSG (nirfsg) | |
+===============================+=======================+
| Driver Version Tested Against | 2025 Q2 |
+-------------------------------+-----------------------+
| PyPI Version | |nirfsgLatestVersion| |
+-------------------------------+-----------------------+
| Supported Python Version | |nirfsgPythonVersion| |
+-------------------------------+-----------------------+
| Documentation | |nirfsgDocs| |
+-------------------------------+-----------------------+
| Open Issues | |nirfsgOpenIssues| |
+-------------------------------+-----------------------+
| Open Pull Requests | |nirfsgOpenPRs| |
+-------------------------------+-----------------------+
.. |nirfsgLatestVersion| image:: http://img.shields.io/pypi/v/nirfsg.svg
:alt: Latest NI-RFSG Version
:target: http://pypi.python.org/pypi/nirfsg
.. |nirfsgPythonVersion| image:: http://img.shields.io/pypi/pyversions/nirfsg.svg
:alt: NI-RFSG supported Python versions
:target: http://pypi.python.org/pypi/nirfsg
.. |nirfsgDocs| image:: https://readthedocs.org/projects/nirfsg/badge/?version=latest
:alt: NI-RFSG Python API Documentation Status
:target: https://nirfsg.readthedocs.io/en/latest
.. |nirfsgOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nirfsg.svg
:alt: Open Issues + Pull Requests for NI-RFSG
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anirfsg
.. |nirfsgOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nirfsg.svg
:alt: Pull Requests for NI-RFSG
:target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anirfsg
.. _nirfsg_installation-section:
Installation
------------
As a prerequisite to using the **nirfsg** module, you must install the NI-RFSG 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-RFSG**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::
$ python -m pip install nirfsg~=1.0.0
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 **nirfsg** module to open a session to an RF Signal Generator and generate a continuous wave (CW) signal.
.. code-block:: python
import nirfsg
# Configure the session
with nirfsg.Session(resource_name='5841', id_query=False, reset_device=False, options='Simulate=1, DriverSetup=Model:5841') as session:
# Configure RF settings
session.configure_rf(
frequency=1e9, # Frequency in Hz
power_level=-10.0 # Power level in dBm
)
session.generation_mode = nirfsg.GenerationMode.CW
# Start signal generation
with session.initiate():
input("Press Enter to stop generation")
`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/nirfsg/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://nirfsg.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": "nirfsg",
"maintainer": "NI",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "opensource@ni.com",
"keywords": "nirfsg",
"author": "NI",
"author_email": "opensource@ni.com",
"download_url": "https://files.pythonhosted.org/packages/39/4b/8f5e266ca11aac2a67e4f97d56448c2883dadcf0af881d6c2ea00393f14d/nirfsg-1.0.0.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 NI Modular Instrument driver APIs for Python.\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 **nirfsg** module provides a Python API for NI-RFSG. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.\n\nSupport Policy\n--------------\n**nirfsg** supports all the Operating Systems supported by NI-RFSG.\n\nIt follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.\n\nNI created and supports **nirfsg**.\n\n\nNI-RFSG Python API Status\n-------------------------\n\n+-------------------------------+-----------------------+\n| NI-RFSG (nirfsg) | |\n+===============================+=======================+\n| Driver Version Tested Against | 2025 Q2 |\n+-------------------------------+-----------------------+\n| PyPI Version | |nirfsgLatestVersion| |\n+-------------------------------+-----------------------+\n| Supported Python Version | |nirfsgPythonVersion| |\n+-------------------------------+-----------------------+\n| Documentation | |nirfsgDocs| |\n+-------------------------------+-----------------------+\n| Open Issues | |nirfsgOpenIssues| |\n+-------------------------------+-----------------------+\n| Open Pull Requests | |nirfsgOpenPRs| |\n+-------------------------------+-----------------------+\n\n\n.. |nirfsgLatestVersion| image:: http://img.shields.io/pypi/v/nirfsg.svg\n :alt: Latest NI-RFSG Version\n :target: http://pypi.python.org/pypi/nirfsg\n\n\n.. |nirfsgPythonVersion| image:: http://img.shields.io/pypi/pyversions/nirfsg.svg\n :alt: NI-RFSG supported Python versions\n :target: http://pypi.python.org/pypi/nirfsg\n\n\n.. |nirfsgDocs| image:: https://readthedocs.org/projects/nirfsg/badge/?version=latest\n :alt: NI-RFSG Python API Documentation Status\n :target: https://nirfsg.readthedocs.io/en/latest\n\n\n.. |nirfsgOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nirfsg.svg\n :alt: Open Issues + Pull Requests for NI-RFSG\n :target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anirfsg\n\n\n.. |nirfsgOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nirfsg.svg\n :alt: Pull Requests for NI-RFSG\n :target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anirfsg\n\n\n\n.. _nirfsg_installation-section:\n\nInstallation\n------------\n\nAs a prerequisite to using the **nirfsg** module, you must install the NI-RFSG 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-RFSG**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::\n\n $ python -m pip install nirfsg~=1.0.0\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 **nirfsg** module to open a session to an RF Signal Generator and generate a continuous wave (CW) signal.\n\n.. code-block:: python\n\n import nirfsg\n\n # Configure the session\n with nirfsg.Session(resource_name='5841', id_query=False, reset_device=False, options='Simulate=1, DriverSetup=Model:5841') as session:\n # Configure RF settings\n session.configure_rf(\n frequency=1e9, # Frequency in Hz\n power_level=-10.0 # Power level in dBm\n )\n session.generation_mode = nirfsg.GenerationMode.CW\n\n # Start signal generation\n with session.initiate():\n input(\"Press Enter to stop generation\")\n\n`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/nirfsg/examples>`_.. _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://nirfsg.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-RFSG Python API",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/ni/nimi-python"
},
"split_keywords": [
"nirfsg"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3ec258bcd62975e452192b4aa7eb199c15abaab6dfbab66a8b810f2b28fe7e64",
"md5": "6a093291446a19eee7653b6fd284ea15",
"sha256": "636eceedefe019d40a7a825808ca42da6db4c7fdc0f65b79541b07f96ce7350f"
},
"downloads": -1,
"filename": "nirfsg-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a093291446a19eee7653b6fd284ea15",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 99986,
"upload_time": "2025-08-05T15:15:52",
"upload_time_iso_8601": "2025-08-05T15:15:52.911749Z",
"url": "https://files.pythonhosted.org/packages/3e/c2/58bcd62975e452192b4aa7eb199c15abaab6dfbab66a8b810f2b28fe7e64/nirfsg-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "394b8f5e266ca11aac2a67e4f97d56448c2883dadcf0af881d6c2ea00393f14d",
"md5": "e538e74cf5f442a9472d563da832e4a4",
"sha256": "4a10ae7f695aadf0e48f0477a95326b4a34e39e1fceb44b673ac0240f0ecf0e7"
},
"downloads": -1,
"filename": "nirfsg-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e538e74cf5f442a9472d563da832e4a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 98532,
"upload_time": "2025-08-05T15:15:54",
"upload_time_iso_8601": "2025-08-05T15:15:54.138441Z",
"url": "https://files.pythonhosted.org/packages/39/4b/8f5e266ca11aac2a67e4f97d56448c2883dadcf0af881d6c2ea00393f14d/nirfsg-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-05 15:15:54",
"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": "nirfsg"
}
JSON
