pyobs-fli 2.0.0.dev3__tar.gz → 2.0.0.dev4__tar.gz

{pyobs_fli-2.0.0.dev3 → pyobs_fli-2.0.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyobs-fli
-Version: 2.0.0.dev3
+Version: 2.0.0.dev4
 Summary: pyobs module for FLI cameras
 Author-Email: Tim-Oliver Husser <thusser@uni-goettingen.de>
 License-Expression: MIT

pyobs_fli-2.0.0.dev4/README.md

@@ -0,0 +1,54 @@
+FLI module for *pyobs*
+======================
+
+This is a [pyobs](https://www.pyobs.org) module for [FLI](http://www.flicamera.com/) cameras and filter wheels.
+
+FLI kernel module
+-----------------
+The FLI kernel module needs to be installed on the system.
+
+
+Install *pyobs-fli*
+--------------------
+Clone the repository:
+
+    git clone https://github.com/pyobs/pyobs-fli.git
+    cd pyobs-fli
+
+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 *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:
+
+    class: pyobs_fli.FliCamera
+    name: FLI camera
+    setpoint: -20.0
+
+For cameras with an FLI filter wheel, use *FliFilterWheel*, which takes a list of filter names:
+
+    class: pyobs_fli.FliFilterWheel
+    name: FLI filter wheel
+    filter_names: [Red, Green, Blue, Clear, Halpha]
+
+
+Dependencies
+------------
+* [pyobs-core](https://github.com/pyobs/pyobs-core) for the core functionality.
+* [Cython](https://cython.org/) for wrapping the FLI SDK.
+* [Astropy](http://www.astropy.org/) for FITS file handling.
+* [NumPy](http://www.numpy.org/) for array handling.

{pyobs_fli-2.0.0.dev3 → pyobs_fli-2.0.0.dev4}/docs/source/index.rst

@@ -55,10 +55,17 @@ This is an example configuration, tested on a FLI 230PL::
 Available classes
 *****************
 
-There is one single class for FLI cameras.
+There are two classes for FLI hardware: :class:`~pyobs_fli.FliCamera` for cameras, and
+:class:`~pyobs_fli.FliFilterWheel` for filter wheels.
 
-AsiCamera
+FliCamera
 =========
 .. autoclass:: pyobs_fli.FliCamera
    :members:
    :show-inheritance:
+
+FliFilterWheel
+==============
+.. autoclass:: pyobs_fli.FliFilterWheel
+   :members:
+   :show-inheritance:

{pyobs_fli-2.0.0.dev3 → pyobs_fli-2.0.0.dev4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyobs-fli"
-version = "2.0.0.dev3"
+version = "2.0.0.dev4"
 description = "pyobs module for FLI cameras"
 authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }]
 requires-python = ">=3.11,<3.14"

{pyobs_fli-2.0.0.dev3 → pyobs_fli-2.0.0.dev4}/uv.lock

@@ -1498,7 +1498,7 @@ wheels = [
 
 [[package]]
 name = "pyobs-fli"
-version = "2.0.0.dev3"
+version = "2.0.0.dev4"
 source = { editable = "." }
 dependencies = [
     { name = "astropy" },

pyobs_fli-2.0.0.dev3/README.md

@@ -1,45 +0,0 @@
-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.