pyobs-flipro 2.0.0.dev3__tar.gz → 2.0.0.dev5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/.github/workflows/ruff.yml +1 -1
  2. pyobs_flipro-2.0.0.dev5/.readthedocs.yml +18 -0
  3. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/PKG-INFO +2 -2
  4. pyobs_flipro-2.0.0.dev5/README.md +61 -0
  5. pyobs_flipro-2.0.0.dev5/docs/Makefile +31 -0
  6. pyobs_flipro-2.0.0.dev5/docs/make.bat +36 -0
  7. pyobs_flipro-2.0.0.dev5/docs/requirements.txt +1 -0
  8. pyobs_flipro-2.0.0.dev5/docs/source/_static/pyobs.gif +0 -0
  9. pyobs_flipro-2.0.0.dev5/docs/source/conf.py +117 -0
  10. pyobs_flipro-2.0.0.dev5/docs/source/index.rst +50 -0
  11. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/pyproject.toml +2 -4
  12. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/uv.lock +379 -171
  13. pyobs_flipro-2.0.0.dev3/.readthedocs.yml +0 -14
  14. pyobs_flipro-2.0.0.dev3/README.md +0 -30
  15. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/.github/workflows/pypi.yml +0 -0
  16. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/.pre-commit-config.yaml +0 -0
  17. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/CMakeLists.txt +0 -0
  18. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/LICENSE +0 -0
  19. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/lib/libflipro.h +0 -0
  20. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/lib/liblibflialgo.so +0 -0
  21. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/lib/liblibflipro.so +0 -0
  22. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/poetry.lock +0 -0
  23. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/pyobs_flipro/__init__.py +0 -0
  24. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/pyobs_flipro/fliprocamera.py +0 -0
  25. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/pyobs_flipro/fliprodriver.pyx +0 -0
  26. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/pyobs_flipro/gui.py +0 -0
  27. {pyobs_flipro-2.0.0.dev3 → pyobs_flipro-2.0.0.dev5}/pyobs_flipro/libflipro.pxd +0 -0
@@ -23,4 +23,4 @@ jobs:
23
23
  run: uv sync --all-extras --dev
24
24
 
25
25
  - name: Run ruff
26
- run: uv run ruff check pyobs_flipro/
26
+ run: uv run --no-sync ruff check pyobs_flipro/
@@ -0,0 +1,18 @@
1
+ version: 2
2
+
3
+ build:
4
+ os: ubuntu-24.04
5
+ tools:
6
+ python: "3.11"
7
+ apt_packages:
8
+ - libcfitsio-dev
9
+ - libusb-1.0-0-dev
10
+
11
+ sphinx:
12
+ configuration: docs/source/conf.py
13
+
14
+ python:
15
+ install:
16
+ - method: pip
17
+ path: .
18
+ - requirements: docs/requirements.txt
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pyobs-flipro
3
- Version: 2.0.0.dev3
3
+ Version: 2.0.0.dev5
4
4
  Summary: pyobs module for FLIPRO cameras
5
5
  Author-Email: Tim-Oliver Husser <thusser@uni-goettingen.de>
6
6
  License-Expression: MIT
@@ -9,6 +9,6 @@ Requires-Dist: astropy<8,>=7.0.1
9
9
  Requires-Dist: numpy<3,>=2.2.5
10
10
  Requires-Dist: pyobs-core<3,>=2.0.0.dev6
11
11
  Provides-Extra: gui
12
- Requires-Dist: PySide6>=6.7; extra == "gui"
12
+ Requires-Dist: pyobs-core[gui]<3,>=2.0.0.dev6; extra == "gui"
13
13
  Requires-Dist: qasync>=0.27; extra == "gui"
14
14
 
@@ -0,0 +1,61 @@
1
+ FLIPRO module for *pyobs*
2
+ =========================
3
+
4
+ This is a [pyobs](https://www.pyobs.org) module for FLI PRO cameras.
5
+
6
+
7
+ System dependencies
8
+ --------------------
9
+ On Debian/Ubuntu:
10
+
11
+ sudo apt-get install libcfitsio-dev libusb-1.0-0-dev
12
+
13
+
14
+ Install *pyobs-flipro*
15
+ ------------------------
16
+ Clone the repository:
17
+
18
+ git clone https://github.com/pyobs/pyobs-flipro.git
19
+ cd pyobs-flipro
20
+
21
+ Install it with [uv](https://docs.astral.sh/uv/):
22
+
23
+ uv sync
24
+
25
+ Alternatively, with plain `venv`/`pip`:
26
+
27
+ python3 -m venv .venv
28
+ source .venv/bin/activate
29
+ pip install .
30
+
31
+
32
+ Configuration
33
+ -------------
34
+ The *FliProCamera* class is derived from *BaseCamera* (see *pyobs* documentation) and adds a single new parameter:
35
+
36
+ setpoint:
37
+ The cooling temperature setpoint in degrees Celsius.
38
+
39
+ A basic module configuration would look like this:
40
+
41
+ class: pyobs_flipro.FliProCamera
42
+ name: FLIPRO camera
43
+ setpoint: -20.0
44
+
45
+
46
+ GUI
47
+ ---
48
+ For testing a camera without a full *pyobs* setup, install the optional `gui` extra:
49
+
50
+ uv sync --extra gui
51
+
52
+ and run:
53
+
54
+ uv run flipro-gui
55
+
56
+
57
+ Dependencies
58
+ ------------
59
+ * [pyobs-core](https://github.com/pyobs/pyobs-core) for the core functionality.
60
+ * [Astropy](http://www.astropy.org/) for FITS file handling.
61
+ * [NumPy](http://www.numpy.org/) for array handling.
@@ -0,0 +1,31 @@
1
+ # Minimal makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line.
5
+ SPHINXOPTS =
6
+ SPHINXBUILD = sphinx-build
7
+ SPHINXPROJ = pyobs
8
+ SOURCEDIR = source
9
+ BUILDDIR = ../.doc-build
10
+
11
+ #.EXPORT_ALL_VARIABLES:
12
+
13
+ #PYTHONPATH:=../pyobs-core/:../pyobs-sbig/:../pyobs-fli:../pyobs-weather:../pyobs-archive:${PYTHONPATH}
14
+
15
+ # Put it first so that "make" without argument is like "make help".
16
+ help:
17
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
18
+
19
+ .PHONY: help Makefile
20
+
21
+ html:
22
+ @$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
23
+
24
+ livehtml:
25
+ sphinx-autobuild -b html --watch ../pyobs_flipro $(ALLSPHINXOPTS) "$(SOURCEDIR)/" "$(BUILDDIR)/html/"
26
+
27
+ # Catch-all target: route all unknown targets to Sphinx using the new
28
+ # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
29
+ %: Makefile
30
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
31
+
@@ -0,0 +1,36 @@
1
+ @ECHO OFF
2
+
3
+ pushd %~dp0
4
+
5
+ REM Command file for Sphinx documentation
6
+
7
+ if "%SPHINXBUILD%" == "" (
8
+ set SPHINXBUILD=sphinx-build
9
+ )
10
+ set SOURCEDIR=source
11
+ set BUILDDIR=build
12
+ set SPHINXPROJ=pyobs
13
+
14
+ if "%1" == "" goto help
15
+
16
+ %SPHINXBUILD% >NUL 2>NUL
17
+ if errorlevel 9009 (
18
+ echo.
19
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
20
+ echo.installed, then set the SPHINXBUILD environment variable to point
21
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
22
+ echo.may add the Sphinx directory to PATH.
23
+ echo.
24
+ echo.If you don't have Sphinx installed, grab it from
25
+ echo.http://sphinx-doc.org/
26
+ exit /b 1
27
+ )
28
+
29
+ %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30
+ goto end
31
+
32
+ :help
33
+ %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34
+
35
+ :end
36
+ popd
@@ -0,0 +1 @@
1
+ sphinx-rtd-theme
@@ -0,0 +1,117 @@
1
+ # Configuration file for the Sphinx documentation builder.
2
+ #
3
+ # This file does only contain a selection of the most common options. For a
4
+ # full list see the documentation:
5
+ # http://www.sphinx-doc.org/en/stable/config
6
+
7
+ # -- Path setup --------------------------------------------------------------
8
+
9
+ # If extensions (or modules to document with autodoc) are in another directory,
10
+ # add these directories to sys.path here. If the directory is relative to the
11
+ # documentation root, use os.path.abspath to make it absolute, like shown here.
12
+ #
13
+ import os
14
+ import sys
15
+
16
+ sys.path.insert(0, os.path.abspath("../../"))
17
+
18
+
19
+ # -- Project information -----------------------------------------------------
20
+
21
+ project = "pyobs-flipro"
22
+ copyright = "2024, Tim-Oliver Husser"
23
+ author = "Tim-Oliver Husser"
24
+
25
+ # The short X.Y version
26
+ # version = "0.16"
27
+ # The full version, including alpha/beta/rc tags
28
+ # release = "0.16.0"
29
+
30
+
31
+ # -- General configuration ---------------------------------------------------
32
+
33
+ add_module_names = False
34
+
35
+ # If your documentation needs a minimal Sphinx version, state it here.
36
+ #
37
+ # needs_sphinx = '1.0'
38
+
39
+ # Add any Sphinx extension module names here, as strings. They can be
40
+ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
41
+ # ones.
42
+ extensions = [
43
+ "sphinx.ext.autodoc",
44
+ "sphinx.ext.githubpages",
45
+ "sphinx.ext.napoleon",
46
+ "sphinx.ext.viewcode",
47
+ "sphinx.ext.autosectionlabel",
48
+ "sphinx.ext.intersphinx",
49
+ #'sphinx_autodoc_typehints'
50
+ ]
51
+
52
+ intersphinx_mapping = {"http://docs.python.org/3": None}
53
+
54
+ # napoleon settings
55
+ napoleon_google_docstring = True
56
+ napoleon_numpy_docstring = False
57
+ napoleon_use_param = False
58
+ napoleon_use_ivar = True
59
+
60
+ # typehints
61
+ # set_type_checking_flag = True
62
+ # autodoc_typehints = "description"
63
+
64
+ # show c'tor parameters in class only
65
+ autoclass_content = "both"
66
+
67
+ # Add any paths that contain templates here, relative to this directory.
68
+ templates_path = ["_templates"]
69
+
70
+ # The suffix(es) of source filenames.
71
+ # You can specify multiple suffix as a list of string:
72
+ #
73
+ source_suffix = ".rst"
74
+
75
+ # The master toctree document.
76
+ master_doc = "index"
77
+
78
+ # The language for content autogenerated by Sphinx. Refer to documentation
79
+ # for a list of supported languages.
80
+ #
81
+ # This is also used if you do content translation via gettext catalogs.
82
+ # Usually you set "language" from the command line for these cases.
83
+ language = "en"
84
+
85
+ # List of patterns, relative to source directory, that match files and
86
+ # directories to ignore when looking for source files.
87
+ # This pattern also affects html_static_path and html_extra_path .
88
+ exclude_patterns = []
89
+
90
+ # The name of the Pygments (syntax highlighting) style to use.
91
+ pygments_style = "sphinx"
92
+
93
+ # Be a little nitpicky
94
+ nitpicky = True
95
+ nitpick_ignore = []
96
+
97
+ # intersphinx
98
+ intersphinx_mapping = {
99
+ "pyobs": ("https://pyobs-core.readthedocs.io/en/latest/", None),
100
+ }
101
+
102
+ # -- Options for HTML output -------------------------------------------------
103
+
104
+ # The theme to use for HTML and HTML Help pages. See the documentation for
105
+ # a list of builtin themes.
106
+ html_theme = "sphinx_rtd_theme"
107
+ html_theme_options = {
108
+ "collapse_navigation": False,
109
+ "sticky_navigation": True,
110
+ "navigation_depth": 4,
111
+ "display_version": False,
112
+ "logo_only": False,
113
+ "prev_next_buttons_location": "bottom",
114
+ "titles_only": False,
115
+ "style_nav_header_background": "#cccccc",
116
+ }
117
+ html_logo = "_static/pyobs.gif"
@@ -0,0 +1,50 @@
1
+ pyobs-flipro
2
+ ############
3
+
4
+ This is a `pyobs <https://www.pyobs.org>`_ (`documentation <https://docs.pyobs.org>`_) module for FLI PRO cameras.
5
+
6
+
7
+ Example configuration
8
+ *********************
9
+
10
+ This is an example configuration::
11
+
12
+ class: pyobs_flipro.FliProCamera
13
+
14
+ # filename pattern
15
+ filenames: /cache/pyobs-{DAY-OBS|date:}-{FRAMENUM|string:04d}-{IMAGETYP|type}00.fits
16
+
17
+ # cooling
18
+ setpoint: -20.0
19
+
20
+ # location
21
+ timezone: utc
22
+ location:
23
+ longitude: 9.944333
24
+ latitude: 51.560583
25
+ elevation: 201.
26
+
27
+ # communication
28
+ comm:
29
+ jid: test@example.com
30
+ password: ***
31
+
32
+ # virtual file system
33
+ vfs:
34
+ class: pyobs.vfs.VirtualFileSystem
35
+ roots:
36
+ cache:
37
+ class: pyobs.vfs.HttpFile
38
+ upload: http://localhost:37075/
39
+
40
+
41
+ Available classes
42
+ *****************
43
+
44
+ There is one single class for FLI PRO cameras.
45
+
46
+ FliProCamera
47
+ ============
48
+ .. autoclass:: pyobs_flipro.FliProCamera
49
+ :members:
50
+ :show-inheritance:
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "pyobs-flipro"
3
- version = "2.0.0.dev3"
3
+ version = "2.0.0.dev5"
4
4
  description = "pyobs module for FLIPRO cameras"
5
5
  authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }]
6
6
  requires-python = ">=3.11"
@@ -13,7 +13,7 @@ dependencies = [
13
13
 
14
14
  [project.optional-dependencies]
15
15
  gui = [
16
- "PySide6>=6.7",
16
+ "pyobs-core[gui]>=2.0.0.dev6,<3",
17
17
  "qasync>=0.27",
18
18
  ]
19
19
 
@@ -23,8 +23,6 @@ dev = [
23
23
  "pre-commit>=4.2.0,<5",
24
24
  "ruff>=0.9.0",
25
25
  "pyrefly>=1.1.1",
26
- "sphinx-rtd-theme>=1.0.0,<2",
27
- "Sphinx>=4.4.0,<5",
28
26
  ]
29
27
 
30
28
  [project.scripts]