nkt-basik


Namenkt-basik JSON
Version 0.3.3 PyPI version JSON
download
home_pagehttps://github.com/ograsdijk/NKT-Basik
SummaryPython interface for the NKT Photonics Basik fiber seed laser
upload_time2023-10-19 05:35:10
maintainer
docs_urlNone
authorograsdijk
requires_python>=3.7,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # NKT-basik
[![Python versions on PyPI](https://img.shields.io/pypi/pyversions/nkt_basik.svg)](https://pypi.python.org/pypi/nkt_basik/)
[![nkt_basik version on PyPI](https://img.shields.io/pypi/v/nkt_basik.svg "NKT Basik on PyPI")](https://pypi.python.org/pypi/nkt_basik/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Interface for [NKT Photonics Basik fiber seed laser](https://www.nktphotonics.com/lasers-fibers/product/koheras-basik-low-noise-single-frequency-oem-laser-modules/), only tested with a Y10 model.  
Consists of a class Basik which has the methods to modify wavelength, frequency, modulation, etc.

## Install
To use the package install with `pip install nkt_basik` or install from source.

## Code Example

```Python
from nkt_basik import Basik

device = Basik('COM4', 1)

# get the wavelength in nm 
print(f'Device wavelength: {device.wavelength} nm')

# get the frequency in GHz
print(f'Device frequency: {device.frequency:.4f} GHz')

# get the temperature in C
print(f'Device temperature: {device.temperature:.1f} C')

# set the wavelength setpoint in nm
print('Setting the wavelength to 1086.77 nm')
device.wavelength = 1086.77

# get the wavelength in nm 
print(f'Device wavelength: {device.wavelength} nm')

# enable emission
print('Enable emission')
device.emission = True

# enable wavelength modulation
device.modulation = True

# get device errors
print('Errors:',device.error)

# get device status
print('Status:',device.status)

# disable emission
print('Disable emission')
device.emission = False

# get device status
print('Status:',device.status)
```

## TODO
* more testing
* add tests

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ograsdijk/NKT-Basik",
    "name": "nkt-basik",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "ograsdijk",
    "author_email": "o.grasdijk@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/9b/76/dbf27e6a9a5b4e9f854526be432190a11e29c74b236aaf3ac896190bf692/nkt_basik-0.3.3.tar.gz",
    "platform": null,
    "description": "# NKT-basik\n[![Python versions on PyPI](https://img.shields.io/pypi/pyversions/nkt_basik.svg)](https://pypi.python.org/pypi/nkt_basik/)\n[![nkt_basik version on PyPI](https://img.shields.io/pypi/v/nkt_basik.svg \"NKT Basik on PyPI\")](https://pypi.python.org/pypi/nkt_basik/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nInterface for [NKT Photonics Basik fiber seed laser](https://www.nktphotonics.com/lasers-fibers/product/koheras-basik-low-noise-single-frequency-oem-laser-modules/), only tested with a Y10 model.  \nConsists of a class Basik which has the methods to modify wavelength, frequency, modulation, etc.\n\n## Install\nTo use the package install with `pip install nkt_basik` or install from source.\n\n## Code Example\n\n```Python\nfrom nkt_basik import Basik\n\ndevice = Basik('COM4', 1)\n\n# get the wavelength in nm \nprint(f'Device wavelength: {device.wavelength} nm')\n\n# get the frequency in GHz\nprint(f'Device frequency: {device.frequency:.4f} GHz')\n\n# get the temperature in C\nprint(f'Device temperature: {device.temperature:.1f} C')\n\n# set the wavelength setpoint in nm\nprint('Setting the wavelength to 1086.77 nm')\ndevice.wavelength = 1086.77\n\n# get the wavelength in nm \nprint(f'Device wavelength: {device.wavelength} nm')\n\n# enable emission\nprint('Enable emission')\ndevice.emission = True\n\n# enable wavelength modulation\ndevice.modulation = True\n\n# get device errors\nprint('Errors:',device.error)\n\n# get device status\nprint('Status:',device.status)\n\n# disable emission\nprint('Disable emission')\ndevice.emission = False\n\n# get device status\nprint('Status:',device.status)\n```\n\n## TODO\n* more testing\n* add tests\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python interface for the NKT Photonics Basik fiber seed laser",
    "version": "0.3.3",
    "project_urls": {
        "Homepage": "https://github.com/ograsdijk/NKT-Basik",
        "Repository": "https://github.com/ograsdijk/NKT-Basik"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eb7db683654469430b710590dd6483d7e2a8e863c7d4467c18224bd51766ac55",
                "md5": "66d7117b3774332b5c9be54384aa8cf0",
                "sha256": "1d7e203e993d317a8e818748e3cc32f322bcb694b5deb288ef85364e8ff5fbae"
            },
            "downloads": -1,
            "filename": "nkt_basik-0.3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "66d7117b3774332b5c9be54384aa8cf0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 6144625,
            "upload_time": "2023-10-19T05:35:07",
            "upload_time_iso_8601": "2023-10-19T05:35:07.017988Z",
            "url": "https://files.pythonhosted.org/packages/eb/7d/b683654469430b710590dd6483d7e2a8e863c7d4467c18224bd51766ac55/nkt_basik-0.3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9b76dbf27e6a9a5b4e9f854526be432190a11e29c74b236aaf3ac896190bf692",
                "md5": "d1fd79ab7413b34796974e9f2a040f0d",
                "sha256": "d6292cc90de88f679b5cf1d76f8e576897ae463bff4c6b17ad4ac4fa2d7e9d99"
            },
            "downloads": -1,
            "filename": "nkt_basik-0.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "d1fd79ab7413b34796974e9f2a040f0d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 6126018,
            "upload_time": "2023-10-19T05:35:10",
            "upload_time_iso_8601": "2023-10-19T05:35:10.542614Z",
            "url": "https://files.pythonhosted.org/packages/9b/76/dbf27e6a9a5b4e9f854526be432190a11e29c74b236aaf3ac896190bf692/nkt_basik-0.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-19 05:35:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ograsdijk",
    "github_project": "NKT-Basik",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "nkt-basik"
}
        
Elapsed time: 0.12842s