backscattermeter_analyzer 3.0.0__tar.gz → 3.0.2__tar.gz

backscattermeter_analyzer-3.0.2/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.5
+Name: backscattermeter_analyzer
+Version: 3.0.2
+Summary: Tool to work on the backscattermeter at LAPP
+Project-URL: Documentation, https://git.linarphy.net/linarphy/backscattermeter_analyzer/wiki
+Project-URL: Homepage, https://git.linarphy.net/linarphy/backscattermeter_analyzer
+Project-URL: Source, https://git.linarphy.net/linarphy/backscattermeter_analyzer
+Project-URL: Issues, https://git.linarphy.net/linarphy/backscattermeter_analyzer/issues
+Author-email: linarphy <linarphy@linarphy.net>
+License-File: LICENSE
+Keywords: backscattered light,virgo
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.14.7
+Requires-Dist: gwpy>=3.0.12
+Requires-Dist: lalsuite>=7.26.15
+Requires-Dist: pyqt6>=6.9.1
+Requires-Dist: pyusb>=1.3.1
+Requires-Dist: rich>=13.9.4
+Description-Content-Type: text/markdown
+
+# Backscattermeter analyzer
+
+Help working with [the backscattermeter at LAPP](https://doi.org/10.48550/arXiv.2202.07370).
+
+This tools can characterize the experiment itself, or make
+${ f } _ { sc }$ or *BRDF* measurement with a focus on uncertainty
+propagation.
+
+## Getting started
+
+### Requirements
+
+- Python >= 3.14
+- GWpy >= 3.0.12 (data type, computation)
+- pyusb >= 1.3.1 (interaction with actuator/sensor - not used yet)
+- pyqt6 >= 6.9.1 (visualization - not used yet)
+- rich >= 13.9.4 (console output)
+- lalsuite >= 7.26.15 (data format - not used yet)
+
+### Installation
+
+To install this package in the current python environment, use
+
+```sh
+python -m pip install backscattermeter_analyzer
+```
+
+### Usage
+
+```py
+from backscattermeter_analyzer import (
+    Acquisition,
+    AnalysisBuilder,
+    Backscattermeter,
+    Camera,
+    ProtocolBuilder,
+)
+from gwpy.timeseries import TimeSeriesDict
+
+# build a protocol with a camera that save the position of the beam and
+# with a snail movement of the motor.
+protocol = (
+    ProtocolBuilder(Backscattermeter())
+    .with_camera_on_suspended_bench(
+        camera=Camera(
+            id_="an nice identifier of the camera for human",
+            serial_number="1359",
+        ),
+        position=3e-2, # in m
+        error=5e-3, # in m
+    )
+    .with_camera_channels( # X and Y are reversed on this camera !
+        pos_x="V1:Camera_scatter_FitPosY",
+        pos_y="V1:Camera_scatter_FitPosX",
+    )
+    .with_snail_motor_path(
+        number=3,
+        duration=10,
+        speed=50,
+        step_numbers=(100, 100, 100, 100),
+    )
+    .build()
+)
+# convert it to an acquisition with real data
+acquisition = Acquisition(
+    protocol=protocol,
+    data=TimeSeriesDict.read("data.gwf"),
+)
+
+# build an analysis where we will get the time interval in which the
+# motor is moving. We don't want these data as they are noisy, so this
+# can be used later for another analysis that needs stable segment.
+analysis = (
+    AnalysisBuilder()
+    .with_step_split([acquisition])
+    .build()
+)
+
+# run the analysis, return a result object
+result = analysis.run()
+
+print(result.representation.structure.with_step_split[0].start_times[0])
+# this will print the start of the segment that contains transition data
+# in camera position measurement.
+```
+
+## Documentation
+
+A complete documentation will be available soon, in a wiki.
+
+## Development
+
+### Development Requirements
+
+This project use [mise](https://mise.jdx.dev) to manage development
+tools.
+
+> [!TIP]
+> If [mise](https://mise.jdx.dev) is installed, and
+> [mise.toml](mise.toml) is trusted with `mise trust`, all tools can be
+> installed automatically with `mise install`
+
+This project use the following tools:
+
+- [just](https://just.systems): command runner
+- [hatch](https://hatch.pypa.io): project manager and package builder
+- [uv](https://docs.astral.sh/uv): package installer
+- [ruff](https://docs.astral.sh/ruff): python linter and formatter
+- [ty](https://docs.astra.sh/ty): python type checker
+- [jujutsu](https://jj-vcs.dev): version control
+
+> [!NOTE]
+> Tools used in the project consume and produce interoperable format to
+> avoid vendor lock-in. This is the toolchain of the current maintener.
+
+### Development Usage
+
+[just](https://just.system) can be used to speed up development for an
+identical toolchain.
+
+Before making a commit, `just fix` will run all tests, format the code,
+lint and type check. If you don’t want to modify the code, `just check`
+will run all tests, lint and type check without any attempt to fix any
+issue.
+
+Before a version change, `just release` will push all local commits to
+repository and publish the new package version.
+
+All available commands can be listed with `just -l`.
+
+## License
+
+This project is licensed under the GNU GPL v3+.
+See [license file](LICENSE) for more information.
+
+## Acknowledgement
+
+Thanks to all the people that worked on the tools used, like python,
+neovim and mise.

backscattermeter_analyzer-3.0.2/README.md

@@ -0,0 +1,139 @@
+# Backscattermeter analyzer
+
+Help working with [the backscattermeter at LAPP](https://doi.org/10.48550/arXiv.2202.07370).
+
+This tools can characterize the experiment itself, or make
+${ f } _ { sc }$ or *BRDF* measurement with a focus on uncertainty
+propagation.
+
+## Getting started
+
+### Requirements
+
+- Python >= 3.14
+- GWpy >= 3.0.12 (data type, computation)
+- pyusb >= 1.3.1 (interaction with actuator/sensor - not used yet)
+- pyqt6 >= 6.9.1 (visualization - not used yet)
+- rich >= 13.9.4 (console output)
+- lalsuite >= 7.26.15 (data format - not used yet)
+
+### Installation
+
+To install this package in the current python environment, use
+
+```sh
+python -m pip install backscattermeter_analyzer
+```
+
+### Usage
+
+```py
+from backscattermeter_analyzer import (
+    Acquisition,
+    AnalysisBuilder,
+    Backscattermeter,
+    Camera,
+    ProtocolBuilder,
+)
+from gwpy.timeseries import TimeSeriesDict
+
+# build a protocol with a camera that save the position of the beam and
+# with a snail movement of the motor.
+protocol = (
+    ProtocolBuilder(Backscattermeter())
+    .with_camera_on_suspended_bench(
+        camera=Camera(
+            id_="an nice identifier of the camera for human",
+            serial_number="1359",
+        ),
+        position=3e-2, # in m
+        error=5e-3, # in m
+    )
+    .with_camera_channels( # X and Y are reversed on this camera !
+        pos_x="V1:Camera_scatter_FitPosY",
+        pos_y="V1:Camera_scatter_FitPosX",
+    )
+    .with_snail_motor_path(
+        number=3,
+        duration=10,
+        speed=50,
+        step_numbers=(100, 100, 100, 100),
+    )
+    .build()
+)
+# convert it to an acquisition with real data
+acquisition = Acquisition(
+    protocol=protocol,
+    data=TimeSeriesDict.read("data.gwf"),
+)
+
+# build an analysis where we will get the time interval in which the
+# motor is moving. We don't want these data as they are noisy, so this
+# can be used later for another analysis that needs stable segment.
+analysis = (
+    AnalysisBuilder()
+    .with_step_split([acquisition])
+    .build()
+)
+
+# run the analysis, return a result object
+result = analysis.run()
+
+print(result.representation.structure.with_step_split[0].start_times[0])
+# this will print the start of the segment that contains transition data
+# in camera position measurement.
+```
+
+## Documentation
+
+A complete documentation will be available soon, in a wiki.
+
+## Development
+
+### Development Requirements
+
+This project use [mise](https://mise.jdx.dev) to manage development
+tools.
+
+> [!TIP]
+> If [mise](https://mise.jdx.dev) is installed, and
+> [mise.toml](mise.toml) is trusted with `mise trust`, all tools can be
+> installed automatically with `mise install`
+
+This project use the following tools:
+
+- [just](https://just.systems): command runner
+- [hatch](https://hatch.pypa.io): project manager and package builder
+- [uv](https://docs.astral.sh/uv): package installer
+- [ruff](https://docs.astral.sh/ruff): python linter and formatter
+- [ty](https://docs.astra.sh/ty): python type checker
+- [jujutsu](https://jj-vcs.dev): version control
+
+> [!NOTE]
+> Tools used in the project consume and produce interoperable format to
+> avoid vendor lock-in. This is the toolchain of the current maintener.
+
+### Development Usage
+
+[just](https://just.system) can be used to speed up development for an
+identical toolchain.
+
+Before making a commit, `just fix` will run all tests, format the code,
+lint and type check. If you don’t want to modify the code, `just check`
+will run all tests, lint and type check without any attempt to fix any
+issue.
+
+Before a version change, `just release` will push all local commits to
+repository and publish the new package version.
+
+All available commands can be listed with `just -l`.
+
+## License
+
+This project is licensed under the GNU GPL v3+.
+See [license file](LICENSE) for more information.
+
+## Acknowledgement
+
+Thanks to all the people that worked on the tools used, like python,
+neovim and mise.

{backscattermeter_analyzer-3.0.0 → backscattermeter_analyzer-3.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "backscattermeter_analyzer"
-version = "3.0.0"
+version = "3.0.2"
 description = "Tool to work on the backscattermeter at LAPP"
 authors = [{ name = "linarphy", email = "linarphy@linarphy.net" }]
 readme = "README.md"

{backscattermeter_analyzer-3.0.0 → backscattermeter_analyzer-3.0.2}/src/backscattermeter_analyzer/experiment/acquisition/acquisition.py

@@ -1,6 +1,6 @@
 """Acquisition class."""
 
-from dataclasses import InitVar, dataclass
+from dataclasses import InitVar, dataclass, field
 from typing import TYPE_CHECKING
 
 from .representation import Representation
@@ -20,7 +20,7 @@ class Acquisition:
     the acquisition.
     """
 
-    representation: Representation
+    representation: Representation = field(init=False)
 
     data: InitVar[TimeSeriesDict]  # type: ignore[ty:invalid-type-form]
     protocol: InitVar[Protocol]

{backscattermeter_analyzer-3.0.0 → backscattermeter_analyzer-3.0.2}/src/backscattermeter_analyzer/experiment/protocol/builder.py

@@ -21,6 +21,9 @@ from backscattermeter_analyzer.experiment.protocol.backscattermeter.sample impor
 from backscattermeter_analyzer.experiment.protocol.camera import (
     With as WithCamera,
 )
+from backscattermeter_analyzer.experiment.protocol.laser.frequency_scan import (
+    With as WithFrequencyScan,
+)
 from backscattermeter_analyzer.experiment.protocol.motor_path import (
     With as WithMotorPath,
 )
@@ -435,6 +438,33 @@ class Builder:
 
         return self
 
+    def with_laser_frequency_scan(
+        self,
+        laser_command: str | Channel,
+    ) -> Self:
+        """
+        Define the laser frequency scan channel.
+
+        Parameters
+        ----------
+        laser_command: str | Channel
+            Channel that will save the frequency command given to the
+            laser.
+
+        """
+
+        if not isinstance(laser_command, Channel):
+            laser_command = Channel(laser_command)
+
+        self.representation.structure.laser.with_frequency_scan = (
+            WithFrequencyScan(
+                laser=self.representation.structure.laser,
+                command=laser_command,
+            )
+        )
+
+        return self
+
     def with_manual_sample_rotation(
         self,
         theta_x: Quantity | float,

backscattermeter_analyzer-3.0.2/src/backscattermeter_analyzer/utils/__init__.py

@@ -0,0 +1 @@
+"""Utils classes and functions for characterization."""

backscattermeter_analyzer-3.0.0/PKG-INFO

@@ -1,26 +0,0 @@
-Metadata-Version: 2.5
-Name: backscattermeter_analyzer
-Version: 3.0.0
-Summary: Tool to work on the backscattermeter at LAPP
-Project-URL: Documentation, https://git.linarphy.net/linarphy/backscattermeter_analyzer/wiki
-Project-URL: Homepage, https://git.linarphy.net/linarphy/backscattermeter_analyzer
-Project-URL: Source, https://git.linarphy.net/linarphy/backscattermeter_analyzer
-Project-URL: Issues, https://git.linarphy.net/linarphy/backscattermeter_analyzer/issues
-Author-email: linarphy <linarphy@linarphy.net>
-License-File: LICENSE
-Keywords: backscattered light,virgo
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.14.7
-Requires-Dist: gwpy>=3.0.12
-Requires-Dist: lalsuite>=7.26.15
-Requires-Dist: pyqt6>=6.9.1
-Requires-Dist: pyusb>=1.3.1
-Requires-Dist: rich>=13.9.4
-Description-Content-Type: text/markdown
-
-# Backscattermeter analyzer

backscattermeter_analyzer-3.0.0/README.md

@@ -1 +0,0 @@
-# Backscattermeter analyzer

backscattermeter_analyzer-3.0.0/src/backscattermeter_analyzer/utils/__init__.py

@@ -1,16 +0,0 @@
-"""Utils classes and functions for characterization."""
-
-from .distance import Distance
-from .measurement import Measurement
-from .ratio import Ratio, RatioCollection
-from .result import Result
-from .utils import seg_time_to_float
-
-__all__ = [
-    "Distance",
-    "Measurement",
-    "Ratio",
-    "RatioCollection",
-    "Result",
-    "seg_time_to_float",
-]