pyobs-fli 1.4.2__tar.gz → 2.0.0.dev1__tar.gz

pyobs_fli-2.0.0.dev1/.github/workflows/pypi.yml

@@ -0,0 +1,26 @@
+name: Publish package to PyPI
+on:
+  push:
+    tags:
+    - 'v*'
+jobs:
+  build-n-publish:
+    name: Build and publish package to PyPI
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: "3.11"
+      - name: Install poetry
+        run: |
+          curl -fsS -o get-poetry.py https://install.python-poetry.org
+          python get-poetry.py -y
+      - name: Publish
+        env:
+          PYPI_TOKEN: ${{ secrets.pypi_password }}
+        run: |
+          $HOME/.local/bin/poetry config pypi-token.pypi $PYPI_TOKEN
+          $HOME/.local/bin/poetry build -f sdist
+          $HOME/.local/bin/poetry publish

pyobs_fli-2.0.0.dev1/.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 25.1.0
+    hooks:
+      - id: black
+        # It is recommended to specify the latest version of Python
+        # supported by your project here, or alternatively use
+        # pre-commit's default_language_version, see
+        # https://pre-commit.com/#top_level-default_language_version
+        language_version: python3.11
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.0
+    hooks:
+      - id: ruff

pyobs_fli-2.0.0.dev1/.readthedocs.yml

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

pyobs_fli-2.0.0.dev1/CHANGELOG.rst

@@ -0,0 +1,2 @@
+v1.0.0 (2022-09-13)
+*******************

pyobs_fli-2.0.0.dev1/CMakeLists.txt

@@ -0,0 +1,86 @@
+cmake_minimum_required(VERSION 3.21)
+project(pyobs_fli LANGUAGES C CXX)
+
+# --- Ensure we use the build environment Python ---
+set(Python3_FIND_VIRTUALENV ONLY)
+set(Python3_FIND_STRATEGY LOCATION)
+find_package(Python3 REQUIRED COMPONENTS Interpreter Development.Module)
+
+# --- Paths ---
+set(PYX_FILE "${CMAKE_CURRENT_SOURCE_DIR}/pyobs_fli/flidriver.pyx")
+set(CXX_FILE "${CMAKE_CURRENT_BINARY_DIR}/flidriver.cpp")
+
+# --- Get NumPy include dir ---
+execute_process(
+  COMMAND "${Python3_EXECUTABLE}" -c "import numpy; print(numpy.get_include())"
+  OUTPUT_VARIABLE NUMPY_INCLUDE_DIR
+  OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+# --- Run Cython (C++ mode) ---
+add_custom_command(
+  OUTPUT ${CXX_FILE}
+  COMMAND "${Python3_EXECUTABLE}" -m cython
+          ${PYX_FILE}
+          --output-file ${CXX_FILE}
+          --cplus
+          -I "${CMAKE_CURRENT_SOURCE_DIR}/pyobs_fli"
+  DEPENDS ${PYX_FILE} "${CMAKE_CURRENT_SOURCE_DIR}/pyobs_fli/libfli.pxd"
+  COMMENT "Running Cython on flidriver.pyx"
+)
+
+# --- Build libfli from source ---
+set(LIBFLI_DIR "${CMAKE_CURRENT_SOURCE_DIR}/lib")
+add_library(fli_static STATIC
+  ${LIBFLI_DIR}/libfli.c
+  ${LIBFLI_DIR}/libfli-camera.c
+  ${LIBFLI_DIR}/libfli-camera-parport.c
+  ${LIBFLI_DIR}/libfli-camera-usb.c
+  ${LIBFLI_DIR}/libfli-filter-focuser.c
+  ${LIBFLI_DIR}/libfli-mem.c
+  ${LIBFLI_DIR}/libfli-raw.c
+  ${LIBFLI_DIR}/unix/libfli-debug.c
+  ${LIBFLI_DIR}/unix/libfli-serial.c
+  ${LIBFLI_DIR}/unix/libfli-sys.c
+  ${LIBFLI_DIR}/unix/libfli-usb.c
+  ${LIBFLI_DIR}/unix/linux/libfli-parport.c
+  ${LIBFLI_DIR}/unix/linux/libfli-usb-sys.c
+)
+target_include_directories(fli_static PUBLIC
+  ${LIBFLI_DIR}
+  ${LIBFLI_DIR}/unix
+)
+target_compile_options(fli_static PRIVATE -Wall -O2 -fPIC)
+
+# --- Build extension module ---
+add_library(flidriver MODULE ${CXX_FILE})
+set_source_files_properties(${CXX_FILE} PROPERTIES LANGUAGE CXX)
+target_include_directories(flidriver PRIVATE
+  ${Python3_INCLUDE_DIRS}
+  ${NUMPY_INCLUDE_DIR}
+  ${LIBFLI_DIR}
+)
+
+# --- Correct Python module naming ---
+execute_process(
+  COMMAND "${Python3_EXECUTABLE}" -c
+          "import sysconfig; print(sysconfig.get_config_var('EXT_SUFFIX'))"
+  OUTPUT_VARIABLE PY_EXT_SUFFIX
+  OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+set_target_properties(flidriver PROPERTIES
+  PREFIX ""
+  OUTPUT_NAME "flidriver"
+  SUFFIX "${PY_EXT_SUFFIX}"
+  POSITION_INDEPENDENT_CODE ON
+)
+message(STATUS "ext: ${PY_EXT_SUFFIX}")
+
+# --- Link ---
+find_library(CFITSIO_LIB cfitsio REQUIRED)
+target_link_libraries(flidriver PRIVATE fli_static ${CFITSIO_LIB})
+
+# --- Install into package ---
+install(TARGETS flidriver
+  LIBRARY DESTINATION ${SKBUILD_PROJECT_NAME}
+)

pyobs_fli-2.0.0.dev1/DEVELOPMENT.md

@@ -0,0 +1,337 @@
+# pyobs 2.0 — Phase 5: External Hardware Modules
+
+This document covers the migration of this pyobs hardware module to the
+pyobs 2.0 API.
+
+---
+
+## Step 0 — Branch main/master into 1.x for legacy support
+
+Before making any changes, preserve the current state as a legacy branch.
+First check which branch is the default — it may be `main` or `master`:
+
+```bash
+git remote show origin | grep "HEAD branch"
+```
+
+**If the default branch is `master`, rename it to `main` first:**
+
+```bash
+git checkout master
+git branch -m master main
+git push origin main
+git push origin --delete master
+# Update the default branch in GitHub repository settings to main
+```
+
+Then branch off for legacy support:
+
+```bash
+git checkout main
+git checkout -b 1.x
+git push origin 1.x
+```
+
+Create `develop` for all 2.0 work:
+
+```bash
+git checkout main
+git checkout -b develop
+git push origin develop
+```
+
+Set `develop` as the default branch in GitHub repository settings.
+
+---
+
+## Step 1 — Add ruff, update tooling
+
+### pyproject.toml changes
+
+1. Bump `pyobs-core` to `>=2.0.0.dev1`.
+
+2. In `[dependency-groups] dev`: add `ruff>=0.9.0`, remove `flake8` and any
+   mypy stub packages (`pandas-stubs`, `pyside6-stubs`, etc.) — pyrefly
+   doesn't use `.pyi` stubs from PyPI.
+
+3. Add config sections (match pyobs-core develop exactly):
+
+```toml
+[tool.ruff]
+target-version = "py311"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "G"]
+
+[tool.pyrefly]
+python-version = "3.11"
+```
+
+> **Note on the `G` rule**: it flags `log.info(f"...")` — all logging calls
+> must use `%`-style formatting: `log.info("value: %s", val)`.
+
+### .pre-commit-config.yaml
+
+Replace the flake8 hook with ruff:
+
+```yaml
+repos:
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 25.1.0
+    hooks:
+      - id: black
+        language_version: python3.11
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.0
+    hooks:
+      - id: ruff
+```
+
+### Delete .flake8
+
+```bash
+rm .flake8
+```
+
+### Run once to fix existing issues
+
+```bash
+uv run ruff check --fix .
+```
+
+---
+
+## Step 2 — Replace get_* with state and capabilities
+
+### Remove getter methods
+
+```python
+# BEFORE (pyobs 1.x)
+async def get_binning(self) -> tuple[int, int]:
+    return self._binning
+
+async def list_binnings(self) -> list[IBinning.State]:
+    return [IBinning.State(x=1, y=1), IBinning.State(x=2, y=2)]
+
+async def get_full_frame(self) -> IWindow.State:
+    return IWindow.State(x=0, y=0, width=self._width, height=self._height)
+```
+
+```python
+# AFTER (pyobs 2.0)
+# In open():
+await self.comm.set_capabilities(IWindow.Capabilities(
+    full_frame=IWindow.State(x=0, y=0, width=self._width, height=self._height)
+))
+await self.comm.set_capabilities(IBinning.Capabilities(
+    binnings=[IBinning.State(x=1, y=1), IBinning.State(x=2, y=2)]
+))
+# Initial states also in open():
+await self.comm.set_state(IWindow.State(x=0, y=0, width=self._width, height=self._height))
+await self.comm.set_state(IBinning.State(x=self._binning[0], y=self._binning[1]))
+# In set_binning():
+await self.comm.set_state(IBinning.State(x=x, y=y))
+```
+
+### Interface → change pattern
+
+| Old getter | New pattern |
+|---|---|
+| `get_full_frame()` | `set_capabilities(IWindow.Capabilities(full_frame=...))` in `open()` |
+| `get_window()` | remove — no equivalent; current window tracked in `_window` and published via `set_state(IWindow.State(...))` |
+| `list_binnings()` | `set_capabilities(IBinning.Capabilities(binnings=[...]))` in `open()` |
+| `list_image_formats()` | `set_capabilities(IImageFormat.Capabilities(image_formats=[...]))` in `open()` |
+| `get_binning()` | `set_state(IBinning.State(...))` in `set_binning()` + `open()` |
+| `get_exposure_status()` | `set_state(IExposure.State(...))` in `_change_exposure_status()` |
+| `get_exposure_time()` | `set_state(IExposureTime.State(...))` in `set_exposure_time()` + `open()` |
+| `get_image_type()` | `set_state(IImageType.State(...))` in `set_image_type()` + `open()` |
+| `get_filter()` | `set_state(IFilters.State(...))` in `set_filter()` + `open()` |
+| `list_filters()` | `set_capabilities(IFilters.Capabilities(filters=[...]))` in `open()` |
+| `get_focus()` | `set_state(IFocuser.State(...))` in `set_focus()` + `open()` |
+| `get_motion_status()` | handled by `MotionStatusMixin` — just call `_change_motion_status()` |
+| `is_ready()` | `set_state(IReady.State(ready=...))` in `open()` and when it changes |
+| `get_cooling()` | `set_state(ICooling.State(setpoint=..., power=..., enabled=...))` in `set_cooling()` and background task |
+| `get_temperatures()` | `set_state(ITemperatures.State(readings=[ITemperatures.Temperature(name=..., value=...)]))` in background polling task |
+| `get_gain()` / `get_offset()` | `set_state(IGain.State(gain=..., offset=...))` in `set_gain()`, `set_offset()` + `open()` |
+| `get_video()` | `set_capabilities(IVideo.Capabilities(url=...))` in `open()` |
+
+### ICooling and ITemperatures
+
+`ICooling` extends `ITemperatures` but they have separate `State` dataclasses.
+Both must be published independently:
+
+```python
+# temperatures (from background polling loop)
+await self.comm.set_state(
+    ITemperatures.State(readings=[ITemperatures.Temperature(name="CCD", value=temp)])
+)
+# cooling control state
+await self.comm.set_state(
+    ICooling.State(setpoint=self._setpoint, power=round(power_pct), enabled=True)
+)
+```
+
+`ICooling.State.power` is typed `int | None` — convert the raw PWM fraction
+(`raw / 255 * 100`) with `round()` before passing it.
+
+### __init__.py re-exports
+
+Ruff's `F401` rule requires explicit re-exports. Change:
+
+```python
+# before
+from .mymodule import MyClass
+```
+
+```python
+# after
+from .mymodule import MyClass as MyClass
+```
+
+---
+
+## Step 3 — Add pyobs-independent GUI
+
+Each hardware module should have a standalone Qt GUI that works without pyobs
+running — useful for testing hardware directly (e.g. during commissioning).
+
+The pattern from **pyobs-qhyccd** (`pyobs_qhyccd/gui.py`) is the reference.
+It uses reusable widgets from `pyobs.utils.gui.*` and talks directly to the
+hardware driver without going through pyobs Comm.
+
+### Typical structure
+
+```python
+# mymodule/gui.py
+import asyncio
+import sys
+import qasync
+from PySide6 import QtWidgets
+from pyobs.utils.gui.camera import (
+    DataDisplayWidget, BinningWidget, ImageFormatWidget,
+    ExposureTimeWidget, ExposeWidget,
+)
+from .driver import MyDriver
+
+
+class MainWindow(QtWidgets.QMainWindow):
+    def __init__(self) -> None:
+        super().__init__()
+        self.driver = MyDriver()
+        self.driver.open()
+        # ... build UI from pyobs.utils.gui widgets ...
+
+    @qasync.asyncSlot()
+    async def _expose_clicked(self) -> None:
+        # ... call driver directly ...
+
+
+def main() -> None:
+    app = QtWidgets.QApplication(sys.argv)
+    asyncio.run(async_main(app), loop_factory=qasync.QEventLoop)
+
+
+if __name__ == "__main__":
+    main()
+```
+
+Register as a console script in `pyproject.toml`:
+
+```toml
+[project.scripts]
+mymodule-gui = "mymodule.gui:main"
+```
+
+### Available pyobs GUI widgets (`pyobs.utils.gui`)
+
+- `camera.DataDisplayWidget` — displays FITS images
+- `camera.BinningWidget` — binning selector
+- `camera.ImageFormatWidget` — INT8/INT16 selector
+- `camera.ExposureTimeWidget` — exposure time spinner
+- `camera.ExposeWidget` — expose/abort buttons with progress
+- `camera.windowingwidget.WindowingWidget` — ROI selector
+
+---
+
+## Step 4 — Testing
+
+Each module should have a `test/` directory with a `local.yaml` config that
+uses `LocalComm` so it can be tested without an XMPP server:
+
+```yaml
+# test/local.yaml
+class: pyobs.modules.MultiModule
+
+vfs: &vfs
+  class: pyobs.vfs.VirtualFileSystem
+  roots:
+    cache:
+      class: pyobs.vfs.LocalFile
+      root: /tmp/pyobs-test/
+
+modules:
+  camera:  # or telescope, focuser, etc.
+    class: mymodule.MyCamera
+    name: camera
+    vfs: *vfs
+    comm:
+      class: pyobs.comm.local.LocalComm
+      name: camera
+
+  gui:
+    class: pyobs_gui.GUI
+    name: gui
+    vfs: *vfs
+    comm:
+      class: pyobs.comm.local.LocalComm
+      name: gui
+```
+
+Run with:
+```bash
+pyobs test/local.yaml
+```
+
+---
+
+## Repo checklist
+
+For each external module repo, in order:
+
+- [ ] Branch `main` → `1.x` (legacy)
+- [ ] Create `develop` branch
+- [ ] Bump `pyobs-core` to `>=2.0.0.dev1` in `pyproject.toml`
+- [ ] Add `ruff>=0.9.0` to dev deps; remove `flake8` and mypy stub packages
+- [ ] Add `[tool.ruff]`, `[tool.ruff.lint]`, `[tool.pyrefly]` sections to `pyproject.toml`
+- [ ] Update `.pre-commit-config.yaml`: replace flake8 hook with ruff
+- [ ] Delete `.flake8`
+- [ ] Run `ruff check --fix .`
+- [ ] Fix re-exports in `__init__.py` (`Foo as Foo`)
+- [ ] Convert f-string log calls to `%`-style (`log.info("x: %s", x)`)
+- [ ] Remove all `get_*` / `list_*` / `is_ready` methods
+- [ ] Add `set_capabilities(...)` calls in `open()`
+- [ ] Add `set_state(...)` calls in `open()` (initial values) and wherever values change
+- [ ] Add standalone GUI in `<package>/gui.py`
+- [ ] Add `test/local.yaml`
+- [ ] Update `README.md` to mention pyobs 2.0 requirement
+
+---
+
+## Key pyobs-core 2.0 APIs
+
+```python
+# In open() — publish static hardware info
+await self.comm.set_capabilities(IWindow.Capabilities(...))
+await self.comm.set_capabilities(IBinning.Capabilities(...))
+
+# In open() and wherever values change — publish live state
+await self.comm.set_state(IBinning.State(x=2, y=2))
+await self.comm.set_state(ICooling.State(setpoint=-20, power=80, enabled=True))
+
+# Presence — set by Module.set_state() automatically
+# No manual action needed
+
+# Reading remote state (e.g. telescope pointing for camera WCS)
+await self.comm.subscribe_state("telescope", IPointingRaDec, self._on_pointing)
+```

pyobs_fli-2.0.0.dev1/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: pyobs-fli
+Version: 2.0.0.dev1
+Summary: pyobs module for FLI cameras
+Author-Email: Tim-Oliver Husser <thusser@uni-goettingen.de>
+License-Expression: MIT
+Requires-Python: <3.14,>=3.11
+Requires-Dist: astropy<8,>=7.0.1
+Requires-Dist: numpy<3,>=2.2.5
+Requires-Dist: pyobs-core<3,>=2.0.0.dev6
+

pyobs_fli-2.0.0.dev1/README.md

@@ -0,0 +1,45 @@
+FLI module for *pyobs*
+======================
+
+FLI kernel module
+-----------------
+The FLI kernel module needs to be installed in the system.
+
+
+Install *pyobs-fli*
+-------------------
+Clone the repository:
+
+    git clone https://github.com/pyobs/pyobs-fli.git
+
+
+Install dependencies:
+
+    cd pyobs-fli
+    pip3 install -r requirements
+        
+And install it:
+
+    python3 setup.py install
+
+
+Configuration
+-------------
+The *FliCamera* class is derived from *BaseCamera* (see *pyobs* documentation) and adds a single new parameter:
+
+    setpoint:
+        The initial setpoint in degrees Celsius for the cooling of the camera.
+
+The class works fine with its default parameters, so a basic module configuration would look like this:
+
+    module:
+      class: pyobs_fli.FliCamera
+      name: FLI camera
+
+Dependencies
+------------
+* **pyobs** for the core funcionality. It is not included in the *requirements.txt*, so needs to be installed 
+  separately.
+* [Cython](https://cython.org/) for wrapping the SBIG Universal Driver.
+* [Astropy](http://www.astropy.org/) for FITS file handling.
+* [NumPy](http://www.numpy.org/) for array handling.

pyobs_fli-2.0.0.dev1/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_sbig $(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_fli-2.0.0.dev1/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_fli-2.0.0.dev1/docs/requirements.txt

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