Skip to content

Use q_max parameter from schema #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jacob-williamson wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Use q_max parameter from schema #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/daq_queuing_service/plugins/i15_1/auxiliary.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from enum import StrEnum
from pathlib import Path
from typing import Literal

from daq_config_server.models.i15_1.standards_puck import StandardsPin
from pydantic import BaseModel, ConfigDict, computed_field
Expand Down Expand Up @@ -32,6 +33,9 @@ def get_background_temperatures(
)


Q_MAX_OPTIONS = Literal[25, 30, 35, 40]


class AuxiliaryScan(BaseModel):
"""Auxiliary scans are scans added automatically by the queue, such as background
scans and standard sample calibration scans. They are needed for analysis of user
Expand All @@ -42,6 +46,7 @@ class AuxiliaryScan(BaseModel):
instrument_session: str
pin: StandardsPin | None
time_per_pdf: float
q_max: Q_MAX_OPTIONS
list_of_temperatures: list[int] | None = None

@computed_field
Expand Down Expand Up @@ -79,6 +84,7 @@ def is_suitable(
self.instrument_session == required_background.instrument_session
and self.pin == required_background.pin
and self.time_per_pdf >= required_background.time_per_pdf
and self.q_max >= required_background.q_max
)

def _temperatures_match(
Expand Down Expand Up @@ -142,6 +148,7 @@ def attempt_to_combine_with(
pin=self.pin,
time_per_pdf=max(self.time_per_pdf, required_background.time_per_pdf),
list_of_temperatures=list_of_temperatures,
q_max=max(self.q_max, required_background.q_max),
)
assert result.is_suitable(required_background)
return result
Expand All @@ -164,6 +171,7 @@ def from_experiment(cls, experiment: Experiment) -> "AuxiliaryScan":
instrument_session=experiment.instrument_session,
pin=pin,
time_per_pdf=experiment.experiment_definition.data["time_per_pdf"],
q_max=experiment.experiment_definition.data["q_max"],
list_of_temperatures=experiment.experiment_definition.data.get(
"list_of_temperatures"
),
Expand Down
9 changes: 8 additions & 1 deletion src/daq_queuing_service/plugins/i15_1/i15_1_converter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,7 @@ def _get_required_auxiliary_scans(
self, experiment: Experiment
) -> list[AuxiliaryScan]:
time_per_pdf = experiment.experiment_definition.data["time_per_pdf"]
q_max = experiment.experiment_definition.data["q_max"]
list_of_temperatures = experiment.experiment_definition.data.get(
"list_of_temperatures"
)
Expand All @@ -307,13 +308,15 @@ def _get_required_auxiliary_scans(
instrument_session=experiment.instrument_session,
pin=None,
time_per_pdf=time_per_pdf,
q_max=q_max,
),
AuxiliaryScan(
instrument_session=experiment.instrument_session,
pin=StandardsPin(
capillary=experiment.sample.data["capillary"], contents=None
),
time_per_pdf=time_per_pdf,
q_max=q_max,
list_of_temperatures=list_of_temperatures,
),
AuxiliaryScan(
Expand All @@ -322,14 +325,18 @@ def _get_required_auxiliary_scans(
capillary=experiment.sample.data["capillary"], contents="Silicon"
),
time_per_pdf=time_per_pdf,
q_max=q_max,
),
]

def _construct_auxiliary_experiment(
self, auxiliary_scan: AuxiliaryScan, instrument_session: str
) -> Experiment:
LOGGER.debug(f"Constructing experiment for auxiliary scan: {auxiliary_scan}")
data: dict[str, Any] = {"time_per_pdf": auxiliary_scan.time_per_pdf}
data: dict[str, Any] = {
"time_per_pdf": auxiliary_scan.time_per_pdf,
"q_max": auxiliary_scan.q_max,
}
if auxiliary_scan.list_of_temperatures:
settle_time = (
self._queue_params.blower_auxiliary_collection_params.settle_time_s
Expand Down
1 change: 1 addition & 0 deletions src/daq_queuing_service/plugins/i15_1/plans.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ def get_data_collection(
"exposure_time_per_frame": data_collection_params.exposure_time_per_frame_s,
"scan_type": scan_type,
"metadata": collection_metadata,
"q_max": experiment_definition.data["q_max"],
}

if experiment_is_blower(experiment):
Expand Down
3 changes: 3 additions & 0 deletions src/daq_queuing_service/plugins/i15_1/tiled_interaction.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ def _query_tiled(instrument_session: str) -> list[TiledAuxiliary]:
.search(Comparison("ge", "stop.time", oldest_valid_time))
.search(In("start.scan_type", list(AuxiliaryScanType)))
.search(KeyPresent("start.experiment_definition.data.time_per_pdf"))
.search(KeyPresent("start.experiment_definition.data.q_max"))
)

items = sorted(
Expand Down Expand Up @@ -70,6 +71,7 @@ def _query_tiled(instrument_session: str) -> list[TiledAuxiliary]:
contents=sample["data"].get("composition"),
)
time_per_pdf = start_doc["experiment_definition"]["data"]["time_per_pdf"]
q_max = start_doc["experiment_definition"]["data"]["q_max"]
list_of_temperatures = start_doc["experiment_definition"]["data"].get(
"list_of_temperatures"
)
Expand All @@ -82,6 +84,7 @@ def _query_tiled(instrument_session: str) -> list[TiledAuxiliary]:
filepath=filepath,
pin=pin,
time_per_pdf=time_per_pdf,
q_max=q_max,
list_of_temperatures=list_of_temperatures,
)
if auxiliary_scan.kind != start_doc["scan_type"]:
Expand Down
43 changes: 43 additions & 0 deletions tests/unit_tests/plugins/i15_1/test_auxiliary.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
list_of_temperatures=[],
),
True,
Expand All @@ -26,11 +28,29 @@
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=35,
list_of_temperatures=[],
),
False,
),
(
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
),
AuxiliaryScan(
instrument_session="def",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
),
False,
),
Expand All @@ -39,11 +59,13 @@
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.5", contents="Silicon"),
time_per_pdf=50,
q_max=30,
),
False,
),
Expand All @@ -52,12 +74,14 @@
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
list_of_temperatures=[100, 200, 300],
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
),
False,
),
Expand All @@ -66,12 +90,14 @@
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
list_of_temperatures=[100, 200, 300],
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
list_of_temperatures=[100, 200, 300, 400],
),
False,
Expand All @@ -81,12 +107,14 @@
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=40,
list_of_temperatures=[90, 290, 490],
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=25,
list_of_temperatures=[95, 250, 300, 450],
),
True,
Expand All @@ -107,18 +135,21 @@ def test_is_suitable_works_as_expected(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=10,
q_max=30,
list_of_temperatures=[150, 250, 350],
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=25,
list_of_temperatures=[100, 200, 300],
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50, # Max time_per_pdf
q_max=30, # Max q_max
list_of_temperatures=[100, 200, 300, 400], # Covers whole temp range
),
),
Expand All @@ -127,35 +158,41 @@ def test_is_suitable_works_as_expected(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=100,
q_max=40,
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=100,
q_max=40,
),
),
(
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=40,
q_max=30,
list_of_temperatures=[50, 610],
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=100,
q_max=30,
list_of_temperatures=[100, 200, 300],
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=100,
q_max=30,
list_of_temperatures=[50, 150, 250, 350, 450, 550, 650],
),
),
Expand All @@ -177,12 +214,14 @@ def test_attempt_to_combine_with_works_as_expected(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=10,
q_max=30,
list_of_temperatures=[150, 250, 350],
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Ga/In"),
time_per_pdf=50,
q_max=30,
list_of_temperatures=[100, 200, 300],
),
),
Expand All @@ -191,12 +230,14 @@ def test_attempt_to_combine_with_works_as_expected(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=10,
q_max=30,
list_of_temperatures=[150, 250, 350],
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
list_of_temperatures=[],
),
),
Expand All @@ -205,11 +246,13 @@ def test_attempt_to_combine_with_works_as_expected(
instrument_session="def",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=10,
q_max=30,
),
AuxiliaryScan(
instrument_session="abc",
pin=StandardsPin(capillary="bs1.0", contents="Silicon"),
time_per_pdf=50,
q_max=30,
),
),
],
Expand Down
Loading
Loading