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

pyobs_fli-2.0.0.dev2/.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:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.11"
+
+      - name: Build
+        run: uv build --sdist
+
+      - name: Publish
+        env:
+          PYPI_TOKEN: ${{ secrets.pypi_password }}
+        run: uv publish --token $PYPI_TOKEN

pyobs_fli-2.0.0.dev2/.github/workflows/ruff.yml

@@ -0,0 +1,26 @@
+name: ruff
+on: push
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.13"
+
+      - name: Install system dependencies
+        run: sudo apt-get install -y libcfitsio-dev
+
+      - name: Install packages
+        run: uv sync --all-extras --dev
+
+      - name: Run ruff
+        run: uv run ruff check pyobs_fli/

pyobs_fli-2.0.0.dev2/.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.dev2/.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.dev2/CHANGELOG.rst

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

pyobs_fli-2.0.0.dev2/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.dev2/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: pyobs-fli
+Version: 2.0.0.dev2
+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.dev2/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.dev2/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.dev2/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.dev2/docs/requirements.txt

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

pyobs_fli-2.0.0.dev2/docs/source/conf.py

@@ -0,0 +1,119 @@
+# -*- coding: utf-8 -*-
+#
+# 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-fli"
+copyright = "2022, 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_fli-2.0.0.dev2/docs/source/index.rst

@@ -0,0 +1,64 @@
+pyobs-fli
+#########
+
+This is a `pyobs <https://www.pyobs.org>`_ (`documentation <https://docs.pyobs.org>`_) module for FLI cameras.
+
+
+Example configuration
+*********************
+
+This is an example configuration, tested on a FLI 230PL::
+
+    class: pyobs_fli.FliCamera
+
+    # filename pattern
+    filenames: /cache/pyobs-ef01-{DAY-OBS|date:}-{FRAMENUM|string:04d}-{IMAGETYP|type}00.fits
+
+    # cooling
+    setpoint: -20.0
+
+    # additional fits headers
+    fits_headers:
+      'DET-PIXL': [0.015, 'Size of detector pixels (square) [mm]']
+      'DET-NAME': ['E2V 230-42 Bi BBAR', 'Name of detector']
+      'DET-GAIN': [1.83, 'Detector gain [e-/ADU]']
+      'DET-RON': [12.1, 'Detector readout noise [e-]']
+      'DET-SATU': [117767, 'Detector saturation limit [e-]']
+
+    # opto-mechanical centre
+    centre: [1115.5, 1047.5]
+
+    # rotation (east of north)
+    rotation: -2.98
+
+    # 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 FLI cameras.
+
+AsiCamera
+=========
+.. autoclass:: pyobs_fli.FliCamera
+   :members:
+   :show-inheritance:

pyobs_fli-2.0.0.dev2/lib/Makefile

@@ -0,0 +1,67 @@
+UNAME	= $(shell uname -s)
+ifeq ($(findstring BSD, $(UNAME)), BSD)
+  UNAME	= BSD
+endif
+
+VPATH	= unix
+ifeq ($(UNAME), Linux)
+  VPATH	+= unix/linux
+endif
+ifeq ($(UNAME), BSD)
+  VPATH	+= unix/bsd
+endif
+ifeq ($(UNAME), Darwin)
+  VPATH	+= unix/osx
+endif
+
+DIR	= $(shell pwd)
+CC	= gcc
+INC	= $(DIR) $(DIR)/unix
+CFLAGS	= -Wall -O2 -g $(patsubst %, -I%, $(INC)) -fPIC
+
+ifeq ($(UNAME), Darwin)
+	CFLAGS += -arch i386 -arch x86_64
+	INC += $(DIR)/unix/osx /Developer/SDKs/MacOSX10.7.sdk/usr/include
+	LIBS =IOkit
+	LIBPATH = /usr/local/lib /sw/lib /usr/lib/ /System/Library/Frameworks/CoreFoundation.framework
+	LDLIBS = $(patsubst %, -l%, $(LIBS))
+	LOADLIBES = $(patsubst %, -L%, $(LIBPATH))
+endif
+
+AR	= ar
+ARFLAGS	= -rus
+
+SYS	= libfli-sys.o
+DEBUG	= libfli-debug.o
+MEM	= libfli-mem.o
+USB_IO	= libfli-usb.o libfli-usb-sys.o
+ifeq ($(UNAME), Linux)
+  PPORT_IO	= libfli-parport.o
+endif
+SERIAL_IO	= libfli-serial.o
+IO	= $(USB_IO) $(PPORT_IO) $(SERIAL_IO)
+CAM	= libfli-camera.o libfli-camera-parport.o libfli-camera-usb.o
+FILT	= libfli-filter-focuser.o
+
+ALLOBJ	= $(SYS) $(DEBUG) $(MEM) $(IO) $(CAM) $(FILT)
+
+libfli.a: libfli.o $(ALLOBJ)
+	$(AR) $(ARFLAGS) $@ $^
+
+doc: doc-html doc-pdf
+
+.PHONY: doc-html
+doc-html: libfli.dxx libfli.h libfli.c
+	doc++ -d doc $<
+
+.PHONY: doc-pdf
+doc-pdf: libfli.dxx libfli.h libfli.c
+	(test -d pdf || mkdir pdf) && cp docxx.sty pdf
+	doc++ -t $< | sed 's/
+	cd pdf && latex libfli.tex && latex libfli.tex
+	cd pdf && dvips -o libfli.ps libfli.dvi && ps2pdf libfli.ps
+	mv pdf/libfli.pdf . && rm -rf pdf
+
+.PHONY: clean
+clean:
+	rm -f $(ALLOBJ) libfli.o libfli.a