Metadata-Version: 2.1
Name: instrbuilder
Version: 0.1.0
Summary: electrical instrument control
Home-page: https://lucask07.github.io/instrbuilder/build/html/
Author: Lucas J. Koerner
Author-email: koerner.lucas@stthomas.edu
License: MIT
Description: *instrbuilder* is an open-source Python package for control of electrical instruments. This package eases the development of high-level "drivers" to interface with oscilloscopes, power supplies, function generators, multimeters, or any instrument that uses ASCII textual string communication (such as SCPI [@scpi1999standard]). *instrbuilder* is particularly suited for prototying and automating experiments in research laboratory setups within an IPython terminal. Our goals are to accelerate the development of automated data collection and improve the reproducibility of laboratory experiments.
        
        ## Documentation 
        
        https://lucask07.github.io/instrbuilder/build/html/
        
        ### Installation Steps
        
        1. Install a VISA driver (National Instruments provides free downloads)
        
        2. Install *instrbuilder*
        
        ```console
        username$ python -m pip instrbuilder 
        ```
        
        3. If using the Bluesky suite uninstall ophyd and re-install from a git fork:
        
        ```console
        username$ python -m pip uninstall ophyd 
        username$ python -m pip install git+https://github.com/lucask07/ophyd@master#egg=ophyd
        ```
        
        ### Getting Started 
        
        1. Command lists for Keysight oscilloscopes, function generator, DMM; Rigol DC Power Supply (*commands.csv*) are included in the package at: *instrbuilder/instruments/* 
        
        2. A YAML file is used to track your specific system configurations and instrument addresses (e.g.USB0::0x0957::0x0407::MY44060286::INSTR). Modify the example YAML file and move to ~/.instrbuilder/ OR create your own
        
        3. Try an example in the source code at *instrbuilder/examples/*. For example: *oscilloscope.py*
        
        ### Create Your Own YAML
        
        1. Initialize a YAML (specify the first parameter, the other 3 should always be default):
        
        ```python 
        from instrbuilder import instrument_opening
        instrument_opening.init_yaml(csv_dir = 'where/your/commands_csv/files/are',
        		cmd_name = 'commands.csv',
        		lookup_name = 'lookup.csv',
        		filename = 'config.yaml')
        ```
        
        2. **Add instruments** to the YAML function use the script found in instrbuilder\examples\add_instruments_to_config.py. This will prompt the user for information. Note that it may be helpful to have only one instrument connected/powered at a time so that there is no ambiguity:
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
