pyobs-zaber 2.0.0.dev5__tar.gz → 2.0.0.dev6__tar.gz

pyobs_zaber-2.0.0.dev6/.readthedocs.yml

@@ -0,0 +1,15 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt

{pyobs_zaber-2.0.0.dev5 → pyobs_zaber-2.0.0.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyobs-zaber
-Version: 2.0.0.dev5
+Version: 2.0.0.dev6
 Summary: pyobs model for Zaber motors
 Author-email: Leon Meerwart <leon.meerwart@uni-goettingen.de>
 License-Expression: MIT

pyobs_zaber-2.0.0.dev6/README.md

@@ -0,0 +1,53 @@
+Zaber module for *pyobs*
+========================
+
+This is a [pyobs](https://www.pyobs.org) module for selecting between named positions (e.g. instrument ports)
+on a [Zaber](https://www.zaber.com/) linear motor.
+
+
+Install *pyobs-zaber*
+-----------------------
+Clone the repository:
+
+    git clone https://github.com/pyobs/pyobs-zaber.git
+    cd pyobs-zaber
+
+Install it with [uv](https://docs.astral.sh/uv/):
+
+    uv sync
+
+Alternatively, with plain `venv`/`pip`:
+
+    python3 -m venv .venv
+    source .venv/bin/activate
+    pip install .
+
+
+Configuration
+-------------
+The *ZaberModeSelector* class takes a dictionary of named modes mapped to motor positions, plus some parameters
+for the underlying Zaber driver:
+
+    modes:
+        Dictionary of available modes in the form {name: position}.
+    port:
+        USB port of the motor (default: /dev/ttyUSB1).
+    speed:
+        Velocity of the selector movement (default: 10000).
+    acceleration:
+        Acceleration of the selector movement (default: 800).
+
+A basic module configuration would look like this:
+
+    class: pyobs_zaber.ZaberModeSelector
+    name: Mode selector
+    port: /dev/ttyUSB0
+    modes:
+      Photometry: 0
+      Spectroscopy: 50000
+
+
+Dependencies
+------------
+* [pyobs-core](https://github.com/pyobs/pyobs-core) for the core functionality.
+* [zaber-motion](https://pypi.org/project/zaber-motion/) for communicating with the motor.

pyobs_zaber-2.0.0.dev6/docs/Makefile

@@ -0,0 +1,31 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = pyobs
+SOURCEDIR     = source
+BUILDDIR      = ../.doc-build
+
+#.EXPORT_ALL_VARIABLES:
+
+#PYTHONPATH:=../pyobs-core/:../pyobs-sbig/:../pyobs-fli:../pyobs-weather:../pyobs-archive:${PYTHONPATH}
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+html:
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+
+livehtml:
+	sphinx-autobuild -b html --watch ../pyobs_zaber $(ALLSPHINXOPTS) "$(SOURCEDIR)/" "$(BUILDDIR)/html/"
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+

pyobs_zaber-2.0.0.dev6/docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=pyobs
+
+if "%1" == "" goto help
+
+%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.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

pyobs_zaber-2.0.0.dev6/docs/requirements.txt

@@ -0,0 +1 @@
+sphinx-rtd-theme

pyobs_zaber-2.0.0.dev6/docs/source/conf.py

@@ -0,0 +1,117 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../../"))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "pyobs-zaber"
+copyright = "2024, Tim-Oliver Husser"
+author = "Tim-Oliver Husser"
+
+# The short X.Y version
+# version = "0.16"
+# The full version, including alpha/beta/rc tags
+# release = "0.16.0"
+
+
+# -- General configuration ---------------------------------------------------
+
+add_module_names = False
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.intersphinx",
+    #'sphinx_autodoc_typehints'
+]
+
+intersphinx_mapping = {"http://docs.python.org/3": None}
+
+# napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+napoleon_use_param = False
+napoleon_use_ivar = True
+
+# typehints
+# set_type_checking_flag = True
+# autodoc_typehints = "description"
+
+# show c'tor parameters in class only
+autoclass_content = "both"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# 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 = "en"
+
+# 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 = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# Be a little nitpicky
+nitpicky = True
+nitpick_ignore = []
+
+# intersphinx
+intersphinx_mapping = {
+    "pyobs": ("https://pyobs-core.readthedocs.io/en/latest/", 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 = "sphinx_rtd_theme"
+html_theme_options = {
+    "collapse_navigation": False,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "display_version": False,
+    "logo_only": False,
+    "prev_next_buttons_location": "bottom",
+    "titles_only": False,
+    "style_nav_header_background": "#cccccc",
+}
+html_logo = "_static/pyobs.gif"

pyobs_zaber-2.0.0.dev6/docs/source/index.rst

@@ -0,0 +1,34 @@
+pyobs-zaber
+###########
+
+This is a `pyobs <https://www.pyobs.org>`_ (`documentation <https://docs.pyobs.org>`_) module for selecting
+between named positions (e.g. instrument ports) on a `Zaber <https://www.zaber.com/>`_ linear motor.
+
+
+Example configuration
+*********************
+
+This is an example configuration::
+
+    class: pyobs_zaber.ZaberModeSelector
+    port: /dev/ttyUSB0
+    modes:
+      Photometry: 0
+      Spectroscopy: 50000
+
+    # communication
+    comm:
+      jid: test@example.com
+      password: ***
+
+
+Available classes
+*****************
+
+There is one single class for Zaber motors.
+
+ZaberModeSelector
+=================
+.. autoclass:: pyobs_zaber.ZaberModeSelector
+   :members:
+   :show-inheritance:

{pyobs_zaber-2.0.0.dev5 → pyobs_zaber-2.0.0.dev6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyobs-zaber"
-version = "2.0.0.dev5"
+version = "2.0.0.dev6"
 description = "pyobs model for Zaber motors"
 authors = [{ name = "Leon Meerwart", email = "leon.meerwart@uni-goettingen.de" }]
 requires-python = ">=3.11"

{pyobs_zaber-2.0.0.dev5 → pyobs_zaber-2.0.0.dev6}/uv.lock

@@ -1766,7 +1766,7 @@ wheels = [
 
 [[package]]
 name = "pyobs-zaber"
-version = "2.0.0.dev5"
+version = "2.0.0.dev6"
 source = { editable = "." }
 dependencies = [
     { name = "pyobs-core" },

pyobs_zaber-2.0.0.dev5/README.md

@@ -1,15 +0,0 @@
-Zaber module for *pyobs*
-========================
-
-Install *pyobs-zaber*
----------------------
-Clone the repository:
-
-    git clone https://github.com/pyobs/pyobs-zaber.git
-
-
-And install it:
-
-    cd pyobs-zaber
-    pip3 install .
-