From 7cfab8af936496f41efa64e1d0fcd73b851e70f0 Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 14:45:43 -0400 Subject: [PATCH 01/18] add some very basic docs --- docs/api.rst | 21 +++++++++++++++++++++ docs/dev_install.rst | 11 +++++++++++ docs/index.rst | 18 +++++++++++++++++- docs/make.bat | 35 ----------------------------------- docs/user_install.rst | 17 +++++++++++++++++ 5 files changed, 66 insertions(+), 36 deletions(-) create mode 100644 docs/api.rst create mode 100644 docs/dev_install.rst delete mode 100644 docs/make.bat create mode 100644 docs/user_install.rst diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..ab1119b --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,21 @@ +API +=== + +.. _Functions: +Functions +--------- + +.. automodule:: qnnpy.functions + :members: + :undoc-members: + :show-inheritance: + +.. _Instruments: +Instruments +----------- + +.. automodule:: qnnpy.instruments + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/dev_install.rst b/docs/dev_install.rst new file mode 100644 index 0000000..5213935 --- /dev/null +++ b/docs/dev_install.rst @@ -0,0 +1,11 @@ +Installation for developers +=========================== + +As with the `user install instructions `, ensure that the MariaDB connection C librariees are installed. + +In order to allow testing of package code, it is recommended to install the package with ``pip`` as editable: + + .. code-block:: bash + pip install -e /path/to/qnnpy + +It is **strongly** recommended to create a separate environment for development work (*e.g.* ``qnnpy-dev``) either using Conda or python venvs. diff --git a/docs/index.rst b/docs/index.rst index 27739d3..f0f6ab7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,9 +6,25 @@ Welcome to qnnpy's documentation! ================================= +``qnnpy`` is a python-based instrument control toolbox for the +Quantum Nanostructure and Nanofabrication Group (QNN) at MIT. +The primary goal of this package is to simplify and standardize the measurement of superconducting nanowire single photon detectors (SNSPDs) and other superconducting nanoelectronics. +This package is split into two main submodules: ``functions``, and ``instruments``. + +This reposotory does not contain commands that will perform your measurements for you. +Its purpose is to organize, standardize, and improve the existing programming infrastructure. + +.. note:: + This project is under active development and the API is subject to change. + +General description +------------------- + .. toctree:: :maxdepth: 2 - :caption: Contents: + api + user_isntall + dev_install diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 954237b..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=. -set BUILDDIR=_build - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.https://www.sphinx-doc.org/ - exit /b 1 -) - -if "%1" == "" goto help - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/user_install.rst b/docs/user_install.rst new file mode 100644 index 0000000..dce0601 --- /dev/null +++ b/docs/user_install.rst @@ -0,0 +1,17 @@ +Installation for users +====================== + +Ensure the MariaDB connection C libraries are installed and accessible in your environment. +This is necessary for the ``mariadb`` python library to interface with the database for storage of measurement results (infrastructure for automating this is WIP). + +If using a Conda environment (recommended), this can be installed `with `_: + + .. code-block:: bash + conda install mariadb-connector-c + +If the system already has the connector software installed, then this step isn't necessary + +Now ``qnnpy`` can be downloaded and installed with ``pip``: + + .. code-block:: bash + pip install qnnpy From 627ac4a386bdfd10332d2325a7f0e9380d7a3a8e Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 14:48:52 -0400 Subject: [PATCH 02/18] change RTD config --- docs/conf.py | 36 ++++++++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 508c223..543c22f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,8 +4,13 @@ # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html +import os +import sys + # -- Path setup -------------------------------------------------------------- +sys.path.insert(0, os.path.abspath(os.path.join("..", "src"))) + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -17,12 +22,12 @@ # -- Project information ----------------------------------------------------- -project = 'qnnpy' -copyright = '2024, Owen Medeiros' -author = 'Owen Medeiros' +project = "qnnpy" +copyright = "2024, Owen Medeiros" +author = "Owen Medeiros" # The full version, including alpha/beta/rc tags -release = '0.1.0' +release = "0.1.0" # -- General configuration --------------------------------------------------- @@ -31,32 +36,43 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + "sphinx.ext.duration", + "sphinx.ext.doctest", + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.autosectionlabel", + "sphinx.ext.extlinks", + "sphinx.ext.intersphinx", + "sphinx.ext.todo", ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = 'python' +language = "python" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] +intersphinx_mapping = { + "python": ("https://docs.python.org/3.10/", None), + "sphinx": ("https://www.sphinx-doc.org/en/master/", None), +} # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = ["_static"] From a09fdb6155455b9e6359145ed1e1ea277f2380a5 Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 14:54:03 -0400 Subject: [PATCH 03/18] fix requirements.txt --- docs/requirements.txt | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 1f99604..53fc1f3 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,2 @@ -ruff -pre-commit -matplotlib \ No newline at end of file +sphinx==7.1.2 +sphinx-rtd-theme==1.3.0rc1 From 4244b6844454b4ff972aecf17ff48e78eda3faf4 Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 15:03:44 -0400 Subject: [PATCH 04/18] change toc --- docs/index.rst | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index f0f6ab7..d365efc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,20 +17,9 @@ Its purpose is to organize, standardize, and improve the existing programming in .. note:: This project is under active development and the API is subject to change. -General description -------------------- - .. toctree:: :maxdepth: 2 + api - user_isntall + user_install dev_install - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` From 947185fa237014561fd870565b659edcb5f0f889 Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 15:06:31 -0400 Subject: [PATCH 05/18] fix code blocks --- docs/dev_install.rst | 4 ++-- docs/user_install.rst | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/dev_install.rst b/docs/dev_install.rst index 5213935..ce1ac8f 100644 --- a/docs/dev_install.rst +++ b/docs/dev_install.rst @@ -5,7 +5,7 @@ As with the `user install instructions `, ensure that the MariaDB In order to allow testing of package code, it is recommended to install the package with ``pip`` as editable: - .. code-block:: bash - pip install -e /path/to/qnnpy +.. code-block:: bash + pip install -e /path/to/qnnpy It is **strongly** recommended to create a separate environment for development work (*e.g.* ``qnnpy-dev``) either using Conda or python venvs. diff --git a/docs/user_install.rst b/docs/user_install.rst index dce0601..af5e962 100644 --- a/docs/user_install.rst +++ b/docs/user_install.rst @@ -6,12 +6,12 @@ This is necessary for the ``mariadb`` python library to interface with the datab If using a Conda environment (recommended), this can be installed `with `_: - .. code-block:: bash - conda install mariadb-connector-c +.. code-block:: bash + conda install mariadb-connector-c If the system already has the connector software installed, then this step isn't necessary Now ``qnnpy`` can be downloaded and installed with ``pip``: - .. code-block:: bash - pip install qnnpy +.. code-block:: bash + pip install qnnpy From ccef2a87ac7392b90de20c3a83a7ec423055884a Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 15:17:25 -0400 Subject: [PATCH 06/18] expanded the install instructions a bit --- docs/dev_install.rst | 1 + docs/user_install.rst | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/dev_install.rst b/docs/dev_install.rst index ce1ac8f..6f2ec91 100644 --- a/docs/dev_install.rst +++ b/docs/dev_install.rst @@ -6,6 +6,7 @@ As with the `user install instructions `, ensure that the MariaDB In order to allow testing of package code, it is recommended to install the package with ``pip`` as editable: .. code-block:: bash + pip install -e /path/to/qnnpy It is **strongly** recommended to create a separate environment for development work (*e.g.* ``qnnpy-dev``) either using Conda or python venvs. diff --git a/docs/user_install.rst b/docs/user_install.rst index af5e962..0fea75c 100644 --- a/docs/user_install.rst +++ b/docs/user_install.rst @@ -7,6 +7,7 @@ This is necessary for the ``mariadb`` python library to interface with the datab If using a Conda environment (recommended), this can be installed `with `_: .. code-block:: bash + conda install mariadb-connector-c If the system already has the connector software installed, then this step isn't necessary @@ -14,4 +15,20 @@ If the system already has the connector software installed, then this step isn't Now ``qnnpy`` can be downloaded and installed with ``pip``: .. code-block:: bash + pip install qnnpy + + +PyVISA +------ + +``qnnpy`` uses ``pyvisa`` to communicate with a variety of instruments. ``pyvisa`` requires a VISA backend to be installed on the system. +Most computers in our lab already have a VISA backend installed, but if you're setting up a new system, you will need to install the appropriate libraries. +:doc:`pyvisa-py ` implements a VISA backend purely in Python and is very easy to install, but comes with some limitations (*e.g.* connecting multiple GPIB adapters to the same PC). +:doc:`NI-VISA https://pyvisa.readthedocs.io/en/latest/faq/getting_nivisa.html>` is another option, and is what is installed on the lab computers. + +USB/GPIB drivers +---------------- + +If you are setting up a new system, you will need to make sure that ``pyvisa`` can interface with your instruments. +Most systems will support TCP/IP devices out of the box, but you may need to install drivers to use the USB or GPIB interfaces on your instruments. From c21bcb0a580906d3c99b14687f14bca79334eaaa Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 15:20:17 -0400 Subject: [PATCH 07/18] fix links --- docs/user_install.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user_install.rst b/docs/user_install.rst index 0fea75c..8997d7a 100644 --- a/docs/user_install.rst +++ b/docs/user_install.rst @@ -24,8 +24,8 @@ PyVISA ``qnnpy`` uses ``pyvisa`` to communicate with a variety of instruments. ``pyvisa`` requires a VISA backend to be installed on the system. Most computers in our lab already have a VISA backend installed, but if you're setting up a new system, you will need to install the appropriate libraries. -:doc:`pyvisa-py ` implements a VISA backend purely in Python and is very easy to install, but comes with some limitations (*e.g.* connecting multiple GPIB adapters to the same PC). -:doc:`NI-VISA https://pyvisa.readthedocs.io/en/latest/faq/getting_nivisa.html>` is another option, and is what is installed on the lab computers. +- :doc:`pyvisa-py ` implements a VISA backend purely in Python and is very easy to install, but comes with some limitations (*e.g.* connecting multiple GPIB adapters to the same PC). +- :doc:`NI-VISA ` is another option, and is what is installed on the lab computers. USB/GPIB drivers ---------------- From 34c94ac0d7bd8848eaed5082a76fdd09c19e160a Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 15:23:54 -0400 Subject: [PATCH 08/18] fix bullet list --- docs/user_install.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/user_install.rst b/docs/user_install.rst index 8997d7a..773b7e5 100644 --- a/docs/user_install.rst +++ b/docs/user_install.rst @@ -24,8 +24,10 @@ PyVISA ``qnnpy`` uses ``pyvisa`` to communicate with a variety of instruments. ``pyvisa`` requires a VISA backend to be installed on the system. Most computers in our lab already have a VISA backend installed, but if you're setting up a new system, you will need to install the appropriate libraries. -- :doc:`pyvisa-py ` implements a VISA backend purely in Python and is very easy to install, but comes with some limitations (*e.g.* connecting multiple GPIB adapters to the same PC). -- :doc:`NI-VISA ` is another option, and is what is installed on the lab computers. + +* `pyvisa-py `_ implements a VISA backend purely in Python and is very easy to install, but comes with some limitations (*e.g.* connecting multiple GPIB adapters to the same PC). + +* `NI-VISA `_ is another option, and is what is installed on the lab computers. USB/GPIB drivers ---------------- From 2e430c1bff2c8d0a74fd83102e3c078623c687b7 Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 15:30:17 -0400 Subject: [PATCH 09/18] fix link between dev/usr install --- docs/dev_install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dev_install.rst b/docs/dev_install.rst index 6f2ec91..373a9aa 100644 --- a/docs/dev_install.rst +++ b/docs/dev_install.rst @@ -1,7 +1,7 @@ Installation for developers =========================== -As with the `user install instructions `, ensure that the MariaDB connection C librariees are installed. +As with the :doc:`user install instructions `, ensure that the MariaDB connection C librariees are installed. In order to allow testing of package code, it is recommended to install the package with ``pip`` as editable: From 4656b03db67641fede2ba5a39b3ea2b546b25e15 Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 15:46:25 -0400 Subject: [PATCH 10/18] install qnnpy when building documentation so that autodoc works --- .readthedocs.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index cd91401..e43298e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -30,4 +30,6 @@ sphinx: # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - - requirements: docs/requirements.txt \ No newline at end of file + - requirements: docs/requirements.txt + - method: pip + path: . From 7554d15053e33929c7e7e2a87f21b14b72723576 Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 15:51:52 -0400 Subject: [PATCH 11/18] struggling with autodoc; just trying to use the example now --- docs/api.rst | 20 +++----------------- 1 file changed, 3 insertions(+), 17 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index ab1119b..e6f1122 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,21 +1,7 @@ API === -.. _Functions: -Functions ---------- - -.. automodule:: qnnpy.functions - :members: - :undoc-members: - :show-inheritance: - -.. _Instruments: -Instruments ------------ - -.. automodule:: qnnpy.instruments - :members: - :undoc-members: - :show-inheritance: +.. autosummary:: + :toctree: generated + qnngds From 83189c8bb99a42f0878e614efb7aa12e9e7dac92 Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 15:54:41 -0400 Subject: [PATCH 12/18] oops fix typo --- docs/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index e6f1122..575dda8 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,4 +4,4 @@ API .. autosummary:: :toctree: generated - qnngds + qnnpy From 3b1955d73b1259e05cd00d71cf303210b70a1504 Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 16:08:31 -0400 Subject: [PATCH 13/18] add napoleon, remove what should be unnecessary pip install of package --- .readthedocs.yaml | 2 -- docs/conf.py | 12 ++++++++++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e43298e..c09aab8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -31,5 +31,3 @@ sphinx: python: install: - requirements: docs/requirements.txt - - method: pip - path: . diff --git a/docs/conf.py b/docs/conf.py index 543c22f..1710042 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,8 +44,20 @@ "sphinx.ext.extlinks", "sphinx.ext.intersphinx", "sphinx.ext.todo", + "sphinx.ext.napoleon", ] +autodoc_member_order = "bysource" + +napoleon_google_docstring = True +napoleon_use_param = False +napoleon_use_rtype = False +napoleon_include_init_with_doc = False +napoleon_attr_annotations = True + +pygments_style = "sphinx" +todo_include_todos = True + # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] From f9b2e68bd0ec33380a91be96d944e03fc32df77d Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 16:13:52 -0400 Subject: [PATCH 14/18] trying stuff from the sphinx docs --- docs/api.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 575dda8..40cf8ab 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,7 +1,8 @@ API === -.. autosummary:: - :toctree: generated +.. automodule:: qnnpy - qnnpy +.. automodule:: qnnpy.functions + +.. automodule:: qnnpy.instruments From 06da8871d4b62cabda2c59947b39394ef5cc94bc Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 16:19:34 -0400 Subject: [PATCH 15/18] trying stuff from stackoverflow post https://stackoverflow.com/questions/2701998/automatically-document-all-modules-recursively-with-sphinx-autodoc --- docs/api.rst | 10 +++++++--- docs/conf.py | 3 +++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 40cf8ab..506ad73 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,8 +1,12 @@ API === +.. + https://stackoverflow.com/questions/2701998/automatically-document-all-modules-recursively-with-sphinx-autodoc -.. automodule:: qnnpy +API stuff -.. automodule:: qnnpy.functions +.. autosummary:: + :toctree: _autosummary + :recursive: -.. automodule:: qnnpy.instruments + qnnpy diff --git a/docs/conf.py b/docs/conf.py index 1710042..b4344e3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -58,6 +58,9 @@ pygments_style = "sphinx" todo_include_todos = True +# https://stackoverflow.com/questions/2701998/automatically-document-all-modules-recursively-with-sphinx-autodoc +autosummary_generate = True + # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] From 88c76a2cdf821c75cb6dc0908e6f9096f663a127 Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 16:28:42 -0400 Subject: [PATCH 16/18] add missing packages required for autodoc to import everything --- docs/requirements.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 53fc1f3..f549f47 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,9 @@ sphinx==7.1.2 sphinx-rtd-theme==1.3.0rc1 + +numpy +pyvisa +mariadb +scipy +matplotlib +nidaqmx From ee4787924652f3f77fe33edb09caf117378d37aa Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 16:35:42 -0400 Subject: [PATCH 17/18] remove mariadb requirement; modules which have it won't get documented well --- docs/requirements.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index f549f47..f1e6d2a 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,7 +3,6 @@ sphinx-rtd-theme==1.3.0rc1 numpy pyvisa -mariadb scipy matplotlib nidaqmx From dd9d87633a11b3c95ace26c3a35b41b7be1b301a Mon Sep 17 00:00:00 2001 From: Reed Foster Date: Mon, 12 Aug 2024 16:47:54 -0400 Subject: [PATCH 18/18] add imports to __init__ to hopefully help with autodoc --- src/qnnpy/__init__.py | 3 ++ src/qnnpy/functions/__init__.py | 18 ++++++++ src/qnnpy/functions/logging/__init__.py | 10 +++++ src/qnnpy/instruments/__init__.py | 58 +++++++++++++++++++++++++ 4 files changed, 89 insertions(+) diff --git a/src/qnnpy/__init__.py b/src/qnnpy/__init__.py index e69de29..d40ce68 100644 --- a/src/qnnpy/__init__.py +++ b/src/qnnpy/__init__.py @@ -0,0 +1,3 @@ +# ruff: noqa: F401 + +from . import functions, logging diff --git a/src/qnnpy/functions/__init__.py b/src/qnnpy/functions/__init__.py index e69de29..119fed3 100644 --- a/src/qnnpy/functions/__init__.py +++ b/src/qnnpy/functions/__init__.py @@ -0,0 +1,18 @@ +# ruff: noqa: F401 + +from . import ( + ICE_plot, + functions, + ic_sweep, + laserctrl, + laserctrl_cmd_based, + logging, + microwave, + ntron, + plotting, + resonators, + save_data_vs_param, + snspd, + tc_measurement, + tc_measurement_muxed, +) diff --git a/src/qnnpy/functions/logging/__init__.py b/src/qnnpy/functions/logging/__init__.py index e69de29..267c9f6 100644 --- a/src/qnnpy/functions/logging/__init__.py +++ b/src/qnnpy/functions/logging/__init__.py @@ -0,0 +1,10 @@ +# ruff: noqa: F401 + +from . import ( + free_space_cryo_logging, + ice_log_pressure_reader, + ice_logging, + ice_logging_script, + janis_300mK_logging, + probe_station_logging, +) diff --git a/src/qnnpy/instruments/__init__.py b/src/qnnpy/instruments/__init__.py index e69de29..512c7fa 100644 --- a/src/qnnpy/instruments/__init__.py +++ b/src/qnnpy/instruments/__init__.py @@ -0,0 +1,58 @@ +# ruff: noqa: F401 + +from . import ( + N5224A, + AQ4321D_tunable_laser, + BK_4060_awg, + ThorlabsPM100_meta, + __init__, + agilent_8153a, + agilent_33250a, + agilent_33600a, + agilent_53131a, + agilent_53230a, + agilent_e5061b, + agilent_n9020a, + anritsu_mg9638a, + attocube_anc150, + attocube_anc300, + cryocon34, + cryocon350, + development_test, + exfo_t100s, + fva3100_optical_attenuator, + hmc_t2240, + hp_3478a, + hp_8157a, + hp_8722c, + hp_83711b, + jds_ha9, + keithley_2001, + keithley_2400, + keithley_2450, + keithley_2700, + keithley_6485, + keithley_DAQ6510, + keysight_53230a, + keysight_b2912a, + keysight_dsox, + keysight_n5224a, + keysight_n7752a, + labjack_u12, + lakeshore336, + lecroy_620zi, + pollux_motor, + redpitaya_12514, + rs_sgs100a, + santec_tsl, + siglent_spd3303, + srs_sim928, + stanford_sr830, + synthhd, + tektronix_5014, + tektronix_rsa5126a, + thorlabs_pm100d, + thorlabs_pm101a, + yokogawa_aq6370, + yokogawa_gs200, +)