Metadata-Version: 2.1
Name: pyscan_tlk
Version: 0.1.9
Summary: Thorlabs Kinesis python wrappers
Author-email: Andy Mounce <ammounce@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Sandia National Laboratories
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Keywords: thorlabs,kinesis,instrument control,science
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: comtypes

# pyscan-tlk
Python wrappers for Thorlabs Kinesis dlls. 

# Contents

This package consists of 33 different python wrapper files for thorlabs kinesis instruments. Each wrapper file consists of nearly all c functions for the instrument, with the exception of those that require `SafeArray` types or failed to import from the dll files.  Examples of using these wrappers is shown in ./test_wrappers/ along with a simulation file. 

# Installation

Usage of this package requires installation of [Thorlabs Kinesis software]{https://www.thorlabs.com/newgrouppage9.cfm?objectgroup_id=10285} for Windows. 

pyscan_tlk is indexed on pypi.org and can be installed by 

`pip install pyscan_tlk`

Alternatively, this git repository can be cloned followed by an editable install (from within the folder where the repository was cloned) via

`pip install -e .`

# Contributions

Pull requests are welcome via merge request. For major changes, please open an issue first to discuss what you would like to change. Bugs may exist as the code was autogenerated by parsig the c '.h' files and documentation. 

For questions please contact: Andy Mounce amounce@sandia.gov

