.. nkt_tools documentation master file, created by
   sphinx-quickstart on Wed May  3 19:01:00 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to nkt_tools's documentation!
=====================================
nkt_tools turns this:

.. code-block:: python

    import NKTP_DLL as nkt
    nkt.registerWriteU8('COM27', 15, 0x30, 0x03, -1)

into this:

.. code-block:: python

    from nkt_tools.extreme import Extreme
    laser = Extreme()
    laser.set_emission(True)

:mod:`nkt_tools` is a wrapper around NKT's DLL to provide object oriented interaction with NKT products. NKT Extreme/Fianium lasers and the Varia system are currently supported. Additional systems can be accessed through the DLL by using the registerRead/Write functions within :mod:`nkt_tools.NKTP_DLL` or interested developers can write new modules by following the :doc:`development notes </development_notes>` provided.

**GitHub Page:**
https://github.com/Dionne-Lab/nkt_tools

**PyPI Page:**
https://pypi.org/project/nkt-tools/

Please also check out my related package, CataLight, which automates data collection and processing for photocatalysis research!

**ReadtheDocs Page:**
https://catalight.readthedocs.io/en/latest/

**PyPI Page:**
https://pypi.org/project/catalight/

Citing
^^^^^^

.. image:: https://zenodo.org/badge/629268582.svg
   :target: https://zenodo.org/badge/latestdoi/629268582

If you utilize the nkt_tools package for you research, we'd appreciate you referencing our Zenodo upload such that others might find our work:

Briley Bourgeois, & Jennifer Dionne. (2023). Dionne-Lab/nkt_tools: 0.0.8 (0.0.8). Zenodo. https://doi.org/10.5281/zenodo.8145215

.. toctree::
   :maxdepth: 3
   :caption: Manual

   guide
   examples
   development_notes


.. toctree::
   :maxdepth: 3
   :caption: Documentation

   api


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`