pyobs-qhyccd 2.0.0.dev7__tar.gz → 2.0.0.dev9__tar.gz

pyobs_qhyccd-2.0.0.dev9/.readthedocs.yml

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

{pyobs_qhyccd-2.0.0.dev7 → pyobs_qhyccd-2.0.0.dev9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyobs-qhyccd
-Version: 2.0.0.dev7
+Version: 2.0.0.dev9
 Summary: pyobs module for QHYCCD cameras
 Author-Email: Tim-Oliver Husser <thusser@uni-goettingen.de>
 License-Expression: MIT
@@ -9,7 +9,6 @@ Requires-Dist: astropy<8,>=7.0.1
 Requires-Dist: numpy<3,>=2.2.5
 Requires-Dist: pyobs-core<3,>=2.0.0.dev6
 Provides-Extra: gui
-Requires-Dist: qfitswidget>=0.13.1; extra == "gui"
-Requires-Dist: pyside6>=6.11.0; extra == "gui"
+Requires-Dist: pyobs-core[gui]<3,>=2.0.0.dev6; extra == "gui"
 Requires-Dist: qasync>=0.28.0; extra == "gui"
 

pyobs_qhyccd-2.0.0.dev9/README.md

@@ -0,0 +1,67 @@
+QHYCCD module for *pyobs*
+=========================
+
+This is a [pyobs](https://www.pyobs.org) module for QHYCCD cameras.
+
+
+System dependencies
+--------------------
+On Debian/Ubuntu, plus the QHYCCD driver:
+
+    sudo apt install build-essential python3-dev libusb-1.0-0-dev libcfitsio-dev
+
+
+Install *pyobs-qhyccd*
+------------------------
+Clone the repository:
+
+    git clone https://github.com/pyobs/pyobs-qhyccd.git
+    cd pyobs-qhyccd
+
+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 *QHYCCDCamera* class is derived from *BaseCamera* (see *pyobs* documentation) and adds a few new parameters:
+
+    setpoint:
+        The cooling temperature setpoint in degrees Celsius (default: -10).
+    params:
+        Optional dictionary of additional QHYCCD control values to set on connect.
+    cooling_step:
+        Maximum change in setpoint per cooling adjustment, in degrees Celsius (default: 1.0).
+    cooling_wait:
+        Time to wait between cooling adjustments, in seconds (default: 60.0).
+
+A basic module configuration would look like this:
+
+    class: pyobs_qhyccd.QHYCCDCamera
+    name: QHYCCD camera
+    setpoint: -10
+
+
+GUI
+---
+For testing a camera without a full *pyobs* setup, install the optional `gui` extra:
+
+    uv sync --extra gui
+
+and run:
+
+    uv run qhyccd-gui
+
+
+Dependencies
+------------
+* [pyobs-core](https://github.com/pyobs/pyobs-core) for the core functionality.
+* [Astropy](http://www.astropy.org/) for FITS file handling.
+* [NumPy](http://www.numpy.org/) for array handling.

pyobs_qhyccd-2.0.0.dev9/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_qhyccd $(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_qhyccd-2.0.0.dev9/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_qhyccd-2.0.0.dev9/docs/requirements.txt

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

pyobs_qhyccd-2.0.0.dev9/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-qhyccd"
+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_qhyccd-2.0.0.dev9/docs/source/index.rst

@@ -0,0 +1,50 @@
+pyobs-qhyccd
+############
+
+This is a `pyobs <https://www.pyobs.org>`_ (`documentation <https://docs.pyobs.org>`_) module for QHYCCD cameras.
+
+
+Example configuration
+*********************
+
+This is an example configuration::
+
+    class: pyobs_qhyccd.QHYCCDCamera
+
+    # cooling
+    setpoint: -10
+
+    # filename pattern
+    filenames: /cache/pyobs-{DAY-OBS|date:}-{FRAMENUM|string:04d}-{IMAGETYP|type}00.fits
+
+    # location
+    timezone: utc
+    location:
+      longitude: 9.944333
+      latitude: 51.560583
+      elevation: 201.
+
+    # communication
+    comm:
+      jid: test@example.com
+      password: ***
+
+    # virtual file system
+    vfs:
+      class: pyobs.vfs.VirtualFileSystem
+      roots:
+        cache:
+          class: pyobs.vfs.HttpFile
+          upload: http://localhost:37075/
+
+
+Available classes
+*****************
+
+There is one single class for QHYCCD cameras.
+
+QHYCCDCamera
+============
+.. autoclass:: pyobs_qhyccd.QHYCCDCamera
+   :members:
+   :show-inheritance: