Metadata-Version: 2.1
Name: nirfsg
Version: 0.1.4
Summary: Python control of NI RF Signal Generators using NI-RFSG
Home-page: UNKNOWN
Author: Lee Johnston
Author-email: lee.johnston.100@gmail.com
License: MIT
Description: ![publish](https://github.com/l-johnston/nirfsg/workflows/publish/badge.svg)
        ![PyPI](https://img.shields.io/pypi/v/nirfsg?style=plastic)
        # `nirfsg`
        Python control of NI RF Signal Generators using NI-RFSG
        
        ## Installation
        
            > pip install nirfsg
        
        Or, after cloning repo:
        
            > pip install .
        
        ## Documentation
        Currently supported models:
        - PXIe-5654
        
        
        ```
        > from nirfsg import PXIe_5654
        > sig_gen = PXIe_5654(<resource>)
        > sig_gen.rf_frequency = 2e6 # Hz
        > sig_gen.rf_power = 0 # dBm
        > sig_gen.initiate()
        ...
        > sig_gen.close()
        ```
        
        As a context manager:
        
        ```
        > with PXIe_5654(<resource>) as sig_gen:
            sig_gen.rf_frequency = 20e9 # Hz
            sig_gen.rf_power = 13 # dBm
            sig_gen.initiate()
            # do some measurements
        ```
        
        Context manager will close the session at exit, which will stop generation.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Science/Research
Description-Content-Type: text/markdown
