ATLAS Offline Software
Loading...
Searching...
No Matches
athenaEF.RunParams Class Reference
Collaboration diagram for athenaEF.RunParams:

Public Member Functions

 __init__ (self, run_number=None, lb_number=None, detector_mask=None, sor_time=None, solenoid_current=None, toroids_current=None, beam_type=None, beam_energy=None, run_type=None, trigger_type=None, recording_enabled=None, conditions_run=None, T0_project_tag='', stream='', lumiblock=0)
 to_dict (self)
 from_args (cls, args)
 from_is (cls, partition=None, webdaq_base=None, strict=False, solenoid_current_override=None, toroids_current_override=None)

Public Attributes

int run_number = run_number if run_number is not None else self.DEFAULT_RUN_NUMBER
int lb_number = lb_number if lb_number is not None else self.DEFAULT_LB_NUMBER
str detector_mask = detector_mask if detector_mask is not None else self.DEFAULT_DETECTOR_MASK
 sor_time = sor_time if sor_time is not None else dt.now().strftime('%d/%m/%y %H:%M:%S.%f')
 solenoid_current = solenoid_current
 toroids_current = toroids_current
int beam_type = beam_type if beam_type is not None else self.DEFAULT_BEAM_TYPE
int beam_energy = beam_energy if beam_energy is not None else self.DEFAULT_BEAM_ENERGY
str run_type = run_type if run_type is not None else self.DEFAULT_RUN_TYPE
int trigger_type = trigger_type if trigger_type is not None else self.DEFAULT_TRIGGER_TYPE
bool recording_enabled = recording_enabled if recording_enabled is not None else self.DEFAULT_RECORDING_ENABLED
 conditions_run = conditions_run
 T0_project_tag = T0_project_tag
 stream = stream
 lumiblock = lumiblock

Static Public Attributes

int DEFAULT_RUN_NUMBER = 0
int DEFAULT_LB_NUMBER = 0
str DEFAULT_DETECTOR_MASK = 'f' * 32
 DEFAULT_SOR_TIME = None
float DEFAULT_SOLENOID_CURRENT = 7730.0
float DEFAULT_TOROIDS_CURRENT = 20400.0
int DEFAULT_BEAM_TYPE = 0
int DEFAULT_BEAM_ENERGY = 0
str DEFAULT_RUN_TYPE = "Physics"
int DEFAULT_TRIGGER_TYPE = 0
bool DEFAULT_RECORDING_ENABLED = False

Detailed Description

Container for run parameters needed by HltEventLoopMgr::prepareForStart().

This class centralizes all run parameter defaults or their retrieval from IS.

Definition at line 63 of file athenaEF.py.

Constructor & Destructor Documentation

◆ __init__()

athenaEF.RunParams.__init__ ( self,
run_number = None,
lb_number = None,
detector_mask = None,
sor_time = None,
solenoid_current = None,
toroids_current = None,
beam_type = None,
beam_energy = None,
run_type = None,
trigger_type = None,
recording_enabled = None,
conditions_run = None,
T0_project_tag = '',
stream = '',
lumiblock = 0 )
Initialize run parameters with defaults for any unspecified values.

Definition at line 83 of file athenaEF.py.

98 lumiblock=0):
99 """Initialize run parameters with defaults for any unspecified values."""
100 self.run_number = run_number if run_number is not None else self.DEFAULT_RUN_NUMBER
101 self.lb_number = lb_number if lb_number is not None else self.DEFAULT_LB_NUMBER
102 self.detector_mask = detector_mask if detector_mask is not None else self.DEFAULT_DETECTOR_MASK
103 self.sor_time = sor_time if sor_time is not None else dt.now().strftime('%d/%m/%y %H:%M:%S.%f')
104 self.solenoid_current = solenoid_current
105 self.toroids_current = toroids_current
106 self.beam_type = beam_type if beam_type is not None else self.DEFAULT_BEAM_TYPE
107 self.beam_energy = beam_energy if beam_energy is not None else self.DEFAULT_BEAM_ENERGY
108 self.run_type = run_type if run_type is not None else self.DEFAULT_RUN_TYPE
109 self.trigger_type = trigger_type if trigger_type is not None else self.DEFAULT_TRIGGER_TYPE
110 self.recording_enabled = recording_enabled if recording_enabled is not None else self.DEFAULT_RECORDING_ENABLED
111 self.conditions_run = conditions_run # Reference run for conditions lookup (None = use run_number)
112 self.T0_project_tag = T0_project_tag
113 self.stream = stream
114 self.lumiblock = lumiblock
115

Member Function Documentation

◆ from_args()

athenaEF.RunParams.from_args ( cls,
args )
Create RunParams from argparse args, using defaults for unset values.

Definition at line 137 of file athenaEF.py.

137 def from_args(cls, args):
138 """Create RunParams from argparse args, using defaults for unset values."""
139 return cls(
140 run_number=args.run_number,
141 lb_number=args.lb_number,
142 detector_mask=args.detector_mask,
143 sor_time=args.sor_time,
144 solenoid_current=getattr(args, 'solenoid_current', None),
145 toroids_current=getattr(args, 'toroids_current', None),
146 conditions_run=getattr(args, 'conditions_run', None),
147 T0_project_tag=getattr(args, 'T0_project_tag', ''),
148 stream=getattr(args, 'stream', ''),
149 lumiblock=getattr(args, 'lumiblock', 0),
150 )
151

◆ from_is()

athenaEF.RunParams.from_is ( cls,
partition = None,
webdaq_base = None,
strict = False,
solenoid_current_override = None,
toroids_current_override = None )
Create RunParams by reading from IS via the WEBDAQ REST API.

This uses the webis_server REST API to fetch run parameters, avoiding
direct dependencies on TDAQ libraries. The API endpoint is determined by:
1. The webdaq_base parameter if provided
2. The TDAQ_WEBDAQ_BASE environment variable

The IS objects accessed are:
- RunParams.RunParams: run_number, det_mask, timeSOR, trigger_type, etc.
- Magnets.Magnets: SolenoidCurrent, ToroidsCurrent

Args:
   partition: The partition name (default: from TDAQ_PARTITION env var)
   webdaq_base: Base URL for webis_server (default: from TDAQ_WEBDAQ_BASE env var)
   strict: If True, raise an exception if IS read fails (for --online-environment)
   solenoid_current_override: If provided, skip IS fetch for solenoid (command-line override)
   toroids_current_override: If provided, skip IS fetch for toroids (command-line override)

Returns:
   RunParams instance with values from IS, or defaults if unavailable

Raises:
   RuntimeError: If strict=True and IS read fails

Definition at line 153 of file athenaEF.py.

154 solenoid_current_override=None, toroids_current_override=None):
155 """
156 Create RunParams by reading from IS via the WEBDAQ REST API.
157
158 This uses the webis_server REST API to fetch run parameters, avoiding
159 direct dependencies on TDAQ libraries. The API endpoint is determined by:
160 1. The webdaq_base parameter if provided
161 2. The TDAQ_WEBDAQ_BASE environment variable
162
163 The IS objects accessed are:
164 - RunParams.RunParams: run_number, det_mask, timeSOR, trigger_type, etc.
165 - Magnets.Magnets: SolenoidCurrent, ToroidsCurrent
166
167 Args:
168 partition: The partition name (default: from TDAQ_PARTITION env var)
169 webdaq_base: Base URL for webis_server (default: from TDAQ_WEBDAQ_BASE env var)
170 strict: If True, raise an exception if IS read fails (for --online-environment)
171 solenoid_current_override: If provided, skip IS fetch for solenoid (command-line override)
172 toroids_current_override: If provided, skip IS fetch for toroids (command-line override)
173
174 Returns:
175 RunParams instance with values from IS, or defaults if unavailable
176
177 Raises:
178 RuntimeError: If strict=True and IS read fails
179 """
180 import requests
181
182 # Determine the base URL
183 if webdaq_base is None:
184 webdaq_base = os.environ.get('TDAQ_WEBDAQ_BASE')
185
186 if not webdaq_base:
187 msg = "TDAQ_WEBDAQ_BASE not set, cannot read from IS"
188 if strict:
189 raise RuntimeError(msg + " (required for --online-environment)")
190 log.warning(msg + ". Using defaults.")
191 return cls()
192
193 # Determine partition
194 if partition is None:
195 partition = os.environ.get('TDAQ_PARTITION', 'ATLAS')
196
197 log.info("Reading run parameters from IS via WEBDAQ: %s (partition=%s)", webdaq_base, partition)
198
199 params = {}
200
201 # Fetch RunParams from IS
202 # API: GET /info/current/{partition}/is/{server}/{server}.{name}?format=compact
203 # Response format: [name, type, timestamp, data] - we need element [3]
204 try:
205 url = f"{webdaq_base}/info/current/{partition}/is/RunParams/RunParams.RunParams?format=compact"
206 log.debug("Fetching RunParams from: %s", url)
207
208 response = requests.get(url, timeout=10)
209 if response.status_code == 200:
210 response_data = response.json()
211 log.debug("RunParams response from IS: %s", response_data)
212
213 # Response is [name, type, timestamp, data]
214 if isinstance(response_data, list) and len(response_data) >= 4:
215 runparams = response_data[3]
216 else:
217 runparams = response_data
218
219 log.debug("RunParams data: %s", runparams)
220
221 # Map IS fields to our RunParams fields
222 if 'run_number' in runparams:
223 params['run_number'] = int(runparams['run_number'])
224 if 'lumiblock' in runparams:
225 params['lb_number'] = int(runparams['lumiblock'])
226 if 'det_mask' in runparams:
227 params['detector_mask'] = runparams['det_mask']
228 if 'timeSOR' in runparams:
229 sor_time = runparams['timeSOR']
230 # Ensure microseconds are present (TrigSORFromPtreeHelper expects format with .%f)
231 if '.' not in sor_time:
232 sor_time += '.000000'
233 params['sor_time'] = sor_time
234 if 'beam_type' in runparams:
235 params['beam_type'] = int(runparams['beam_type'])
236 if 'beam_energy' in runparams:
237 params['beam_energy'] = int(runparams['beam_energy'])
238 if 'run_type' in runparams:
239 params['run_type'] = runparams['run_type']
240 if 'trigger_type' in runparams:
241 params['trigger_type'] = int(runparams['trigger_type'])
242 if 'recording_enabled' in runparams:
243 params['recording_enabled'] = runparams['recording_enabled'] in ('1', 'true', 'True', True, 1)
244
245 log.info("Got run parameters from IS: run=%s, lb=%s",
246 params.get('run_number'), params.get('lb_number'))
247 else:
248 msg = f"Failed to fetch RunParams from IS: HTTP {response.status_code}"
249 if strict:
250 raise RuntimeError(msg + " (required for --online-environment)")
251 log.warning(msg)
252
253 except requests.exceptions.RequestException as e:
254 msg = f"Error fetching RunParams from IS: {e}"
255 if strict:
256 raise RuntimeError(msg + " (required for --online-environment)")
257 log.warning(msg)
258 except (ValueError, KeyError) as e:
259 msg = f"Error parsing RunParams from IS: {e}"
260 if strict:
261 raise RuntimeError(msg + " (required for --online-environment)")
262 log.warning(msg)
263
264 # Fetch Magnets from IS
265 # In strict mode (online environment), magnets are required unless provided via command line
266 # If command-line overrides are provided, use those instead of fetching from IS
267 have_solenoid_override = solenoid_current_override is not None
268 have_toroids_override = toroids_current_override is not None
269
270 if have_solenoid_override:
271 params['solenoid_current'] = solenoid_current_override
272 log.info("Using solenoid_current=%.1f from command line override", solenoid_current_override)
273 if have_toroids_override:
274 params['toroids_current'] = toroids_current_override
275 log.info("Using toroids_current=%.1f from command line override", toroids_current_override)
276
277 # Only fetch from IS if we need at least one value
278 if not (have_solenoid_override and have_toroids_override):
279 try:
280 url = f"{webdaq_base}/info/current/{partition}/is/Magnets/Magnets.Magnets?format=compact"
281 log.debug("Fetching Magnets from: %s", url)
282
283 response = requests.get(url, timeout=10)
284 if response.status_code == 200:
285 response_data = response.json()
286 log.debug("Magnets response from IS: %s", response_data)
287
288 magnets = response_data[3] if isinstance(response_data, list) and len(response_data) >= 4 else response_data
289 log.debug("Magnets data: %s", magnets)
290
291 # Magnets structure: { "SolenoidCurrent": {"value": ..., "ts": ...},
292 # "ToroidsCurrent": {"value": ..., "ts": ...} }
293 if not have_solenoid_override:
294 params['solenoid_current'] = float(magnets['SolenoidCurrent']['value'])
295 if not have_toroids_override:
296 params['toroids_current'] = float(magnets['ToroidsCurrent']['value'])
297
298 log.info("Got magnet currents from IS: solenoid=%s, toroids=%s",
299 params.get('solenoid_current'), params.get('toroids_current'))
300 elif strict:
301 raise RuntimeError(f"Magnets not available from IS: HTTP {response.status_code} "
302 "(required for --online-environment, use --solenoid-current and --toroids-current to override)")
303 else:
304 log.debug("Magnets not available from IS: HTTP %d", response.status_code)
305
306 except requests.exceptions.RequestException as e:
307 if strict:
308 raise RuntimeError(f"Error fetching Magnets from IS: {e} "
309 "(required for --online-environment, use --solenoid-current and --toroids-current to override)")
310 log.debug("Error fetching Magnets from IS: %s", e)
311 except (ValueError, KeyError, TypeError) as e:
312 if strict:
313 raise RuntimeError(f"Error parsing Magnets from IS: {e} "
314 "(required for --online-environment, use --solenoid-current and --toroids-current to override)")
315 log.debug("Error parsing Magnets from IS: %s", e)
316
317 # In strict mode, verify we got at least run_number from IS
318 if strict and 'run_number' not in params:
319 raise RuntimeError("Failed to get run_number from IS (required for --online-environment)")
320
321 return cls(**params)
322
323

◆ to_dict()

athenaEF.RunParams.to_dict ( self)
Return run parameters as a dictionary for prepareForStart.

Definition at line 116 of file athenaEF.py.

116 def to_dict(self):
117 """Return run parameters as a dictionary for prepareForStart."""
118 return {
119 'run_number': self.run_number,
120 'lb_number': self.lb_number,
121 'detector_mask': self.detector_mask,
122 'sor_time': self.sor_time,
123 'solenoid_current': self.solenoid_current,
124 'toroids_current': self.toroids_current,
125 'beam_type': self.beam_type,
126 'beam_energy': self.beam_energy,
127 'run_type': self.run_type,
128 'trigger_type': self.trigger_type,
129 'recording_enabled': self.recording_enabled,
130 'conditions_run': self.conditions_run,
131 'T0_project_tag': self.T0_project_tag,
132 'stream': self.stream,
133 'lumiblock': self.lumiblock,
134 }
135

Member Data Documentation

◆ beam_energy

athenaEF.RunParams.beam_energy = beam_energy if beam_energy is not None else self.DEFAULT_BEAM_ENERGY

Definition at line 107 of file athenaEF.py.

◆ beam_type

athenaEF.RunParams.beam_type = beam_type if beam_type is not None else self.DEFAULT_BEAM_TYPE

Definition at line 106 of file athenaEF.py.

◆ conditions_run

athenaEF.RunParams.conditions_run = conditions_run

Definition at line 111 of file athenaEF.py.

◆ DEFAULT_BEAM_ENERGY

int athenaEF.RunParams.DEFAULT_BEAM_ENERGY = 0
static

Definition at line 78 of file athenaEF.py.

◆ DEFAULT_BEAM_TYPE

int athenaEF.RunParams.DEFAULT_BEAM_TYPE = 0
static

Definition at line 77 of file athenaEF.py.

◆ DEFAULT_DETECTOR_MASK

str athenaEF.RunParams.DEFAULT_DETECTOR_MASK = 'f' * 32
static

Definition at line 73 of file athenaEF.py.

◆ DEFAULT_LB_NUMBER

int athenaEF.RunParams.DEFAULT_LB_NUMBER = 0
static

Definition at line 72 of file athenaEF.py.

◆ DEFAULT_RECORDING_ENABLED

bool athenaEF.RunParams.DEFAULT_RECORDING_ENABLED = False
static

Definition at line 81 of file athenaEF.py.

◆ DEFAULT_RUN_NUMBER

int athenaEF.RunParams.DEFAULT_RUN_NUMBER = 0
static

Definition at line 71 of file athenaEF.py.

◆ DEFAULT_RUN_TYPE

str athenaEF.RunParams.DEFAULT_RUN_TYPE = "Physics"
static

Definition at line 79 of file athenaEF.py.

◆ DEFAULT_SOLENOID_CURRENT

float athenaEF.RunParams.DEFAULT_SOLENOID_CURRENT = 7730.0
static

Definition at line 75 of file athenaEF.py.

◆ DEFAULT_SOR_TIME

athenaEF.RunParams.DEFAULT_SOR_TIME = None
static

Definition at line 74 of file athenaEF.py.

◆ DEFAULT_TOROIDS_CURRENT

float athenaEF.RunParams.DEFAULT_TOROIDS_CURRENT = 20400.0
static

Definition at line 76 of file athenaEF.py.

◆ DEFAULT_TRIGGER_TYPE

int athenaEF.RunParams.DEFAULT_TRIGGER_TYPE = 0
static

Definition at line 80 of file athenaEF.py.

◆ detector_mask

athenaEF.RunParams.detector_mask = detector_mask if detector_mask is not None else self.DEFAULT_DETECTOR_MASK

Definition at line 102 of file athenaEF.py.

◆ lb_number

athenaEF.RunParams.lb_number = lb_number if lb_number is not None else self.DEFAULT_LB_NUMBER

Definition at line 101 of file athenaEF.py.

◆ lumiblock

athenaEF.RunParams.lumiblock = lumiblock

Definition at line 114 of file athenaEF.py.

◆ recording_enabled

athenaEF.RunParams.recording_enabled = recording_enabled if recording_enabled is not None else self.DEFAULT_RECORDING_ENABLED

Definition at line 110 of file athenaEF.py.

◆ run_number

athenaEF.RunParams.run_number = run_number if run_number is not None else self.DEFAULT_RUN_NUMBER

Definition at line 100 of file athenaEF.py.

◆ run_type

athenaEF.RunParams.run_type = run_type if run_type is not None else self.DEFAULT_RUN_TYPE

Definition at line 108 of file athenaEF.py.

◆ solenoid_current

athenaEF.RunParams.solenoid_current = solenoid_current

Definition at line 104 of file athenaEF.py.

◆ sor_time

athenaEF.RunParams.sor_time = sor_time if sor_time is not None else dt.now().strftime('%d/%m/%y %H:%M:%S.%f')

Definition at line 103 of file athenaEF.py.

◆ stream

athenaEF.RunParams.stream = stream

Definition at line 113 of file athenaEF.py.

◆ T0_project_tag

athenaEF.RunParams.T0_project_tag = T0_project_tag

Definition at line 112 of file athenaEF.py.

◆ toroids_current

athenaEF.RunParams.toroids_current = toroids_current

Definition at line 105 of file athenaEF.py.

◆ trigger_type

athenaEF.RunParams.trigger_type = trigger_type if trigger_type is not None else self.DEFAULT_TRIGGER_TYPE

Definition at line 109 of file athenaEF.py.


The documentation for this class was generated from the following file: