Metadata-Version: 2.4
Name: nirfmxvna
Version: 26.3.0
Summary: Python APIs for interacting with RFmx VNA Product
License: MIT
License-File: LICENSE
Keywords: rfmx,nirfmx,nirfmxvna
Author: NI
Author-email: opensource@ni.com
Maintainer: Thangam V
Maintainer-email: thangam.v@emerson.com
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
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: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Scientific/Engineering :: Instrument Drivers
Provides-Extra: dev
Requires-Dist: fasteners (>=0.19)
Requires-Dist: grpcio (>=1.49.0,<2.0)
Requires-Dist: hightime (>=0.2.2)
Requires-Dist: nirfmxinstr (==26.3.0)
Requires-Dist: numpy (>=1.22) ; python_version >= "3.9" and python_version < "3.12" and implementation_name != "pypy"
Requires-Dist: numpy (>=1.26) ; implementation_name != "pypy" and python_version == "3.12"
Requires-Dist: numpy (>=2.1) ; implementation_name == "pypy" and python_version == "3.10"
Requires-Dist: numpy (>=2.1) ; python_version >= "3.13" and python_version < "4.0" and implementation_name != "pypy"
Requires-Dist: numpy (>=2.3) ; python_version >= "3.11" and python_version < "4.0" and implementation_name == "pypy"
Requires-Dist: protobuf (>=4.21)
Project-URL: Documentation, https://nirfmx-python-nirfmxvna.readthedocs-hosted.com/
Project-URL: Repository, https://github.com/ni/nirfmx-python
Description-Content-Type: text/markdown

| **Info**      | Contains Python APIs for interacting with RFmx VNA Product. |
| :------------ | :-------------------------------------------------------------- |
| **Author**    | National Instruments                                            |

# Table of Contents

- [Table of Contents](#table-of-contents)
- [About](#about)
  - [Documentation](#documentation)
  - [Operating System Support](#operating-system-support)
- [Installation](#installation)
- [License](#license)
- [Support and Feedback](#support-and-feedback)
- [Example](#example)


# About

The **nirfmx-python** repository generates Python bindings (Application Programming Interface)
for interacting with the RFmx Products.

**nirfmx-python** follows [Python Software Foundation](https://devguide.python.org/#status-of-python-branches)
support policy for different versions.


## RFmx Instr Python API Status

| Item                         | Details                      |
|------------------------------|-------------------------------|
| **Driver Version Tested**    | [2026 Q2](http://www.ni.com/downloads/)                      |
| **Supported Python Versions**| Python 3.9+ (64-bit)    |
| **Documentation**            | [RFmx Instr Docs](https://nirfmx-python-nirfmxinstr.readthedocs-hosted.com/en/latest/) |


## RFmx VNA Python API Status

| Item                         | Details                      |
|------------------------------|-------------------------------|
| **Driver Version Tested**    | [2026 Q2](http://www.ni.com/downloads/)                      |
| **Supported Python Versions**| Python 3.9+ (64-bit)    |
| **Documentation**            | [RFmx VNA Docs](https://nirfmx-python-nirfmxvna.readthedocs-hosted.com/en/latest/) |


## Documentation

You can find the latest API documentation for the **nirfmx-python** package
on [Read the Docs](https://nirfmx-python-nirfmxinstr.readthedocs-hosted.com/en/latest/)

Refer to the [RFmx User Manual](https://www.ni.com/docs/en-US/bundle/rfmx/page/user-manual-welcome.html)
for an overview of RFmx, system requirements, troubleshooting, key concepts, etc.


## Operating System Support

**nirfmx-python** supports Windows systems where the supported drivers are 
installed. Refer to [NI Hardware and Operating System Compatibility](https://www.ni.com/r/hw-support) for 
which versions of the driver support your hardware on a given operating system.


## Installation

You can use [pip](http://pypi.python.org/pypi/pip) to download [nirfmxvna](https://pypi.org/project/nirfmxvna/) and install it.
    
    $ python -m pip install nirfmxvna

## Upgrade

You can use [pip](http://pypi.python.org/pypi/pip) to upgrade [nirfmxvna](https://pypi.org/project/nirfmxvna/) package using following command:

    $ python -m pip install nirfmxvna --upgrade


## License

This project is licensed under the MIT License. While the source code is not publicly released,
the license permits binary distribution with attribution.

**Note:** This Python driver depends on several third-party components that are subject to separate
commercial licenses. Users are responsible for ensuring they have the appropriate rights and licenses
to use those dependencies in their environments.


# gRPC Features

For driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to nirfmxinstr.Session.__init__() is subject to the NI General Purpose EULA.


# SSL/TLS Support

The server supports both server-side TLS and mutual TLS. Security configuration is accomplished by setting the `server_cert`, `server_key` and `root_cert` values in the server's configuration file. The server expects the certificate files specified in the configuration file to exist in a `certs` folder that is located in the same directory as the configuration file being used by the server. For more detailed information on SSL/TLS support refer to the [Server Security Support wiki page](https://github.com/ni/grpc-device/wiki/Server-Security-Support).


## Support and Feedback

For support with Python API, hardware, the driver runtime or any other questions,
please visit [NI Community Forums](https://forums.ni.com/).


## RFmxVNA Example

```python
import nirfmxinstr
import nirfmxvna
import numpy

instr_session = None
vna_signal = None

try:
  # Create a new RFmx Session
  instr_session = nirfmxinstr.Session(resource_name, option_string)

  # Get VNA signal configuration
  vna_signal = instr_session.get_vna_signal_configuration()

  instr_session.configure_frequency_reference(
    "", frequency_reference_source, frequency_reference_frequency
  )

  vna_signal.set_sweep_type("", sweep_type)
  vna_signal.set_start_frequency("", start_frequency)
  vna_signal.set_stop_frequency("", stop_frequency)
  vna_signal.set_number_of_points("", frequency_points)
  vna_signal.set_if_bandwidth("", if_bandwidth)

  port_selector_string = nirfmxvna.Vna.build_port_string("", "port1")
  vna_signal.set_power_level(port_selector_string, port1_power_level)
  vna_signal.set_test_receiver_attenuation(
    port_selector_string, port1_test_receiver_attenuation
  )

  port_selector_string = nirfmxvna.Vna.build_port_string("", "port2")
  vna_signal.set_power_level(port_selector_string, port2_power_level)
  vna_signal.set_test_receiver_attenuation(
    port_selector_string, port2_test_receiver_attenuation
  )

  vna_signal.set_averaging_enabled("", averaging_enabled)
  vna_signal.set_averaging_count("", averaging_count)

  vna_signal.select_measurements("", measurement, enable_all_traces)

  vna_signal.waves.configuration.set_number_of_waves("", number_of_waves)

  for i in range(number_of_waves):
    wave_selector_string = nirfmxvna.Vna.build_wave_string("", i)
    vna_signal.waves.configuration.configure_wave(wave_selector_string, waves[i])
    vna_signal.waves.configuration.set_format(wave_selector_string, waves_formats[i])

  vna_signal.waves.configuration.set_magnitude_units("", magnitude_units)
  vna_signal.waves.configuration.set_phase_trace_type("", phase_trace_type)

  vna_signal.initiate("", "")

  # Retrieve results
  number_of_waves_result, error_code = vna_signal.waves.configuration.get_number_of_waves("")

  waves_x_data_result = numpy.empty(0, dtype=numpy.float64)
  waves_x_data_result = vna_signal.waves.results.fetch_x_data("", timeout)

  waves_y1_data_result = []
  waves_y2_data_result = []

  for i in range(number_of_waves_result):
    wave_selector_string = nirfmxvna.Vna.build_wave_string("", i)

    y1_data, y2_data, error_code = vna_signal.waves.results.fetch_y_data(
      wave_selector_string, timeout
    )

    waves_y1_data_result.append(y1_data)
    waves_y2_data_result.append(y2_data)

except Exception as e:
  print(f"Error occurred: {e}")
  sys.exit(1)

finally:
  if vna_signal is not None:
    vna_signal.dispose()
    vna_signal = None
  if instr_session is not None:
    instr_session.close()
    instr_session = None
```
