Skip to content

Commit 4f68ada

Browse files
skbarberskbarber
committed
update to new ScanPaths refactor
1 parent 47f1036 commit 4f68ada

File tree

1 file changed

+86
-78
lines changed

1 file changed

+86
-78
lines changed

‎docs/geecs_data_utils/examples/scans_database_utils.ipynb‎

Lines changed: 86 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,17 @@
2020
},
2121
{
2222
"cell_type": "code",
23-
"execution_count": null,
23+
"execution_count": 6,
2424
"id": "85e6225b-a1d7-4c90-b8d9-5cf877449551",
2525
"metadata": {},
2626
"outputs": [],
2727
"source": [
2828
"from datetime import date\n",
29-
"from geecs_data_utils import ScanData\n",
29+
"from geecs_data_utils import ScanPaths\n",
3030
"from geecs_data_utils.scans_database.builder import ScanDatabaseBuilder\n",
3131
"\n",
3232
"# Inputs\n",
33-
"data_root = ScanData.paths_config.base_path\n",
33+
"data_root = ScanPaths.paths_config.base_path\n",
3434
"experiment = \"Undulator\"\n",
3535
"output_path = data_root / experiment / \"scan_database_parquet\"\n",
3636
"date_range = (date(2022, 1, 3), date(2025, 8, 5))\n",
@@ -56,7 +56,7 @@
5656
},
5757
{
5858
"cell_type": "code",
59-
"execution_count": null,
59+
"execution_count": 7,
6060
"id": "bd71d3d4-9c17-498b-8d3b-bf47eec64b54",
6161
"metadata": {},
6262
"outputs": [],
@@ -82,7 +82,7 @@
8282
},
8383
{
8484
"cell_type": "code",
85-
"execution_count": 10,
85+
"execution_count": 5,
8686
"id": "3f507f67-1b9d-4529-9174-d85bd267265f",
8787
"metadata": {},
8888
"outputs": [
@@ -140,13 +140,13 @@
140140
" </thead>\n",
141141
" <tbody>\n",
142142
" <tr>\n",
143-
" <th>0</th>\n",
144-
" <td>7</td>\n",
145-
" <td>1</td>\n",
143+
" <th>3</th>\n",
144+
" <td>5</td>\n",
145+
" <td>2</td>\n",
146146
" <td>Undulator</td>\n",
147-
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S...</td>\n",
148-
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S...</td>\n",
149-
" <td>[Z_Test_Scope]</td>\n",
147+
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S...</td>\n",
148+
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S...</td>\n",
149+
" <td>[UC_BCaveMagSpecCam1, UC_BCaveMagSpecCam1-inte...</td>\n",
150150
" <td>Shotnumber</td>\n",
151151
" <td>0</td>\n",
152152
" <td>1</td>\n",
@@ -155,7 +155,7 @@
155155
" <td>noscan</td>\n",
156156
" <td>. scanning Shotnumber. None</td>\n",
157157
" <td>0</td>\n",
158-
" <td>{\"Scan No\": \"1\", \"ScanStartInfo\": \". scanning ...</td>\n",
158+
" <td>{\"Scan No\": \"2\", \"ScanStartInfo\": \". scanning ...</td>\n",
159159
" <td>{\"experiment_name\": \"Undulator\", \"devices\": [{...</td>\n",
160160
" <td>1</td>\n",
161161
" <td>&lt;NA&gt;</td>\n",
@@ -164,22 +164,22 @@
164164
" <td>{'experiment_name': 'Undulator', 'devices': [{...</td>\n",
165165
" </tr>\n",
166166
" <tr>\n",
167-
" <th>1</th>\n",
168-
" <td>7</td>\n",
169-
" <td>2</td>\n",
167+
" <th>4</th>\n",
168+
" <td>5</td>\n",
169+
" <td>3</td>\n",
170170
" <td>Undulator</td>\n",
171-
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S...</td>\n",
172-
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S...</td>\n",
173-
" <td>[Z_Test_Scope, Z_Test_Scope_2]</td>\n",
171+
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S...</td>\n",
172+
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S...</td>\n",
173+
" <td>[UC_BCaveMagSpecCam1, UC_BCaveMagSpecCam1-inte...</td>\n",
174174
" <td>Shotnumber</td>\n",
175175
" <td>0</td>\n",
176176
" <td>1</td>\n",
177177
" <td>1</td>\n",
178178
" <td>...</td>\n",
179179
" <td>noscan</td>\n",
180-
" <td>. scanning Shotnumber. None</td>\n",
180+
" <td>no scan for EMP diagnostics. scanning Shotnumb...</td>\n",
181181
" <td>0</td>\n",
182-
" <td>{\"Scan No\": \"2\", \"ScanStartInfo\": \". scanning ...</td>\n",
182+
" <td>{\"Scan No\": \"3\", \"ScanStartInfo\": \"no scan for...</td>\n",
183183
" <td>{\"experiment_name\": \"Undulator\", \"devices\": [{...</td>\n",
184184
" <td>1</td>\n",
185185
" <td>&lt;NA&gt;</td>\n",
@@ -188,22 +188,22 @@
188188
" <td>{'experiment_name': 'Undulator', 'devices': [{...</td>\n",
189189
" </tr>\n",
190190
" <tr>\n",
191-
" <th>2</th>\n",
192-
" <td>7</td>\n",
193-
" <td>3</td>\n",
191+
" <th>6</th>\n",
192+
" <td>5</td>\n",
193+
" <td>5</td>\n",
194194
" <td>Undulator</td>\n",
195-
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S...</td>\n",
196-
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S...</td>\n",
197-
" <td>[Z_Test_Scope, Z_Test_Scope_2]</td>\n",
195+
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S...</td>\n",
196+
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S...</td>\n",
197+
" <td>[UC_BCaveMagSpecCam1, UC_BCaveMagSpecCam1-inte...</td>\n",
198198
" <td>Shotnumber</td>\n",
199199
" <td>0</td>\n",
200200
" <td>1</td>\n",
201201
" <td>1</td>\n",
202202
" <td>...</td>\n",
203203
" <td>noscan</td>\n",
204-
" <td>. scanning Shotnumber. None</td>\n",
204+
" <td>no scan. scanning Shotnumber. None</td>\n",
205205
" <td>0</td>\n",
206-
" <td>{\"Scan No\": \"3\", \"ScanStartInfo\": \". scanning ...</td>\n",
206+
" <td>{\"Scan No\": \"5\", \"ScanStartInfo\": \"no scan. sc...</td>\n",
207207
" <td>{\"experiment_name\": \"Undulator\", \"devices\": [{...</td>\n",
208208
" <td>1</td>\n",
209209
" <td>&lt;NA&gt;</td>\n",
@@ -212,22 +212,22 @@
212212
" <td>{'experiment_name': 'Undulator', 'devices': [{...</td>\n",
213213
" </tr>\n",
214214
" <tr>\n",
215-
" <th>3</th>\n",
216-
" <td>7</td>\n",
217-
" <td>4</td>\n",
215+
" <th>7</th>\n",
216+
" <td>5</td>\n",
217+
" <td>6</td>\n",
218218
" <td>Undulator</td>\n",
219-
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S...</td>\n",
220-
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S...</td>\n",
221-
" <td>[Z_Test_Scope, Z_Test_Scope_2]</td>\n",
219+
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S...</td>\n",
220+
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S...</td>\n",
221+
" <td>[UC_BCaveMagSpecCam1, UC_BCaveMagSpecCam1-inte...</td>\n",
222222
" <td>Shotnumber</td>\n",
223223
" <td>0</td>\n",
224224
" <td>1</td>\n",
225225
" <td>1</td>\n",
226226
" <td>...</td>\n",
227227
" <td>noscan</td>\n",
228-
" <td>. scanning Shotnumber. None</td>\n",
228+
" <td>no scan. scanning Shotnumber. None</td>\n",
229229
" <td>0</td>\n",
230-
" <td>{\"Scan No\": \"4\", \"ScanStartInfo\": \". scanning ...</td>\n",
230+
" <td>{\"Scan No\": \"6\", \"ScanStartInfo\": \"no scan. sc...</td>\n",
231231
" <td>{\"experiment_name\": \"Undulator\", \"devices\": [{...</td>\n",
232232
" <td>1</td>\n",
233233
" <td>&lt;NA&gt;</td>\n",
@@ -236,22 +236,22 @@
236236
" <td>{'experiment_name': 'Undulator', 'devices': [{...</td>\n",
237237
" </tr>\n",
238238
" <tr>\n",
239-
" <th>4</th>\n",
240-
" <td>7</td>\n",
239+
" <th>8</th>\n",
241240
" <td>5</td>\n",
241+
" <td>7</td>\n",
242242
" <td>Undulator</td>\n",
243-
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S...</td>\n",
244-
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S...</td>\n",
245-
" <td>[UC_ALineEBeam3, U_BCaveICT, Z_Test_Scope, Z_T...</td>\n",
243+
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S...</td>\n",
244+
" <td>Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S...</td>\n",
245+
" <td>[UC_ALineEBeam3, U_BCaveICT, U_RTA4000, Z_Test...</td>\n",
246246
" <td>Shotnumber</td>\n",
247247
" <td>0</td>\n",
248248
" <td>1</td>\n",
249249
" <td>1</td>\n",
250250
" <td>...</td>\n",
251251
" <td>noscan</td>\n",
252-
" <td>statistics scan on BAM. scanning Shotnumber. None</td>\n",
252+
" <td>no scan opn bhaci bam. scanning Shotnumber. None</td>\n",
253253
" <td>0</td>\n",
254-
" <td>{\"Scan No\": \"5\", \"ScanStartInfo\": \"statistics ...</td>\n",
254+
" <td>{\"Scan No\": \"7\", \"ScanStartInfo\": \"no scan opn...</td>\n",
255255
" <td>{\"experiment_name\": \"Undulator\", \"devices\": [{...</td>\n",
256256
" <td>1</td>\n",
257257
" <td>&lt;NA&gt;</td>\n",
@@ -266,58 +266,58 @@
266266
],
267267
"text/plain": [
268268
" day number experiment scalar_data_file \\\n",
269-
"0 7 1 Undulator Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S... \n",
270-
"1 7 2 Undulator Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S... \n",
271-
"2 7 3 Undulator Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S... \n",
272-
"3 7 4 Undulator Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S... \n",
273-
"4 7 5 Undulator Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S... \n",
269+
"3 5 2 Undulator Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S... \n",
270+
"4 5 3 Undulator Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S... \n",
271+
"6 5 5 Undulator Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S... \n",
272+
"7 5 6 Undulator Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S... \n",
273+
"8 5 7 Undulator Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S... \n",
274274
"\n",
275275
" tdms_file \\\n",
276-
"0 Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S... \n",
277-
"1 Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S... \n",
278-
"2 Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S... \n",
279-
"3 Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S... \n",
280-
"4 Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0807\\scans\\S... \n",
276+
"3 Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S... \n",
277+
"4 Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S... \n",
278+
"6 Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S... \n",
279+
"7 Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S... \n",
280+
"8 Z:\\data\\Undulator\\Y2025\\08-Aug\\25_0805\\scans\\S... \n",
281281
"\n",
282282
" non_scalar_devices scan_parameter start end \\\n",
283-
"0 [Z_Test_Scope] Shotnumber 0 1 \n",
284-
"1 [Z_Test_Scope, Z_Test_Scope_2] Shotnumber 0 1 \n",
285-
"2 [Z_Test_Scope, Z_Test_Scope_2] Shotnumber 0 1 \n",
286-
"3 [Z_Test_Scope, Z_Test_Scope_2] Shotnumber 0 1 \n",
287-
"4 [UC_ALineEBeam3, U_BCaveICT, Z_Test_Scope, Z_T... Shotnumber 0 1 \n",
283+
"3 [UC_BCaveMagSpecCam1, UC_BCaveMagSpecCam1-inte... Shotnumber 0 1 \n",
284+
"4 [UC_BCaveMagSpecCam1, UC_BCaveMagSpecCam1-inte... Shotnumber 0 1 \n",
285+
"6 [UC_BCaveMagSpecCam1, UC_BCaveMagSpecCam1-inte... Shotnumber 0 1 \n",
286+
"7 [UC_BCaveMagSpecCam1, UC_BCaveMagSpecCam1-inte... Shotnumber 0 1 \n",
287+
"8 [UC_ALineEBeam3, U_BCaveICT, U_RTA4000, Z_Test... Shotnumber 0 1 \n",
288288
"\n",
289289
" step_size ... scan_mode scan_description \\\n",
290-
"0 1 ... noscan . scanning Shotnumber. None \n",
291-
"1 1 ... noscan . scanning Shotnumber. None \n",
292-
"2 1 ... noscan . scanning Shotnumber. None \n",
293290
"3 1 ... noscan . scanning Shotnumber. None \n",
294-
"4 1 ... noscan statistics scan on BAM. scanning Shotnumber. None \n",
291+
"4 1 ... noscan no scan for EMP diagnostics. scanning Shotnumb... \n",
292+
"6 1 ... noscan no scan. scanning Shotnumber. None \n",
293+
"7 1 ... noscan no scan. scanning Shotnumber. None \n",
294+
"8 1 ... noscan no scan opn bhaci bam. scanning Shotnumber. None \n",
295295
"\n",
296296
" background scan_metadata_raw_fields \\\n",
297-
"0 0 {\"Scan No\": \"1\", \"ScanStartInfo\": \". scanning ... \n",
298-
"1 0 {\"Scan No\": \"2\", \"ScanStartInfo\": \". scanning ... \n",
299-
"2 0 {\"Scan No\": \"3\", \"ScanStartInfo\": \". scanning ... \n",
300-
"3 0 {\"Scan No\": \"4\", \"ScanStartInfo\": \". scanning ... \n",
301-
"4 0 {\"Scan No\": \"5\", \"ScanStartInfo\": \"statistics ... \n",
297+
"3 0 {\"Scan No\": \"2\", \"ScanStartInfo\": \". scanning ... \n",
298+
"4 0 {\"Scan No\": \"3\", \"ScanStartInfo\": \"no scan for... \n",
299+
"6 0 {\"Scan No\": \"5\", \"ScanStartInfo\": \"no scan. sc... \n",
300+
"7 0 {\"Scan No\": \"6\", \"ScanStartInfo\": \"no scan. sc... \n",
301+
"8 0 {\"Scan No\": \"7\", \"ScanStartInfo\": \"no scan opn... \n",
302302
"\n",
303303
" ecs_dump has_analysis_dir notes \\\n",
304-
"0 {\"experiment_name\": \"Undulator\", \"devices\": [{... 1 <NA> \n",
305-
"1 {\"experiment_name\": \"Undulator\", \"devices\": [{... 1 <NA> \n",
306-
"2 {\"experiment_name\": \"Undulator\", \"devices\": [{... 1 <NA> \n",
307304
"3 {\"experiment_name\": \"Undulator\", \"devices\": [{... 1 <NA> \n",
308305
"4 {\"experiment_name\": \"Undulator\", \"devices\": [{... 1 <NA> \n",
306+
"6 {\"experiment_name\": \"Undulator\", \"devices\": [{... 1 <NA> \n",
307+
"7 {\"experiment_name\": \"Undulator\", \"devices\": [{... 1 <NA> \n",
308+
"8 {\"experiment_name\": \"Undulator\", \"devices\": [{... 1 <NA> \n",
309309
"\n",
310310
" year month __ecs \n",
311-
"0 2025 8 {'experiment_name': 'Undulator', 'devices': [{... \n",
312-
"1 2025 8 {'experiment_name': 'Undulator', 'devices': [{... \n",
313-
"2 2025 8 {'experiment_name': 'Undulator', 'devices': [{... \n",
314311
"3 2025 8 {'experiment_name': 'Undulator', 'devices': [{... \n",
315312
"4 2025 8 {'experiment_name': 'Undulator', 'devices': [{... \n",
313+
"6 2025 8 {'experiment_name': 'Undulator', 'devices': [{... \n",
314+
"7 2025 8 {'experiment_name': 'Undulator', 'devices': [{... \n",
315+
"8 2025 8 {'experiment_name': 'Undulator', 'devices': [{... \n",
316316
"\n",
317317
"[5 rows x 21 columns]"
318318
]
319319
},
320-
"execution_count": 10,
320+
"execution_count": 5,
321321
"metadata": {},
322322
"output_type": "execute_result"
323323
}
@@ -326,7 +326,7 @@
326326
"from geecs_data_utils.scans_database.database import ScanDatabase\n",
327327
"from datetime import date\n",
328328
"\n",
329-
"data_root = ScanData.paths_config.base_path\n",
329+
"data_root = ScanPaths.paths_config.base_path\n",
330330
"experiment = \"Undulator\"\n",
331331
"output_path = data_root / experiment / \"scan_database_parquet\"\n",
332332
"\n",
@@ -353,13 +353,21 @@
353353
"print(\"rows:\", len(df))\n",
354354
"df.head(5)"
355355
]
356+
},
357+
{
358+
"cell_type": "code",
359+
"execution_count": null,
360+
"id": "472f43ab-4711-4c54-a658-b99273a6e84b",
361+
"metadata": {},
362+
"outputs": [],
363+
"source": []
356364
}
357365
],
358366
"metadata": {
359367
"kernelspec": {
360-
"display_name": "Python (geecs-plugins, poetry)",
368+
"display_name": "geecs-plugins",
361369
"language": "python",
362-
"name": "geecs-plugins-py310"
370+
"name": "geecs-plugins"
363371
},
364372
"language_info": {
365373
"codemirror_mode": {
@@ -371,7 +379,7 @@
371379
"name": "python",
372380
"nbconvert_exporter": "python",
373381
"pygments_lexer": "ipython3",
374-
"version": "3.10.11"
382+
"version": "3.10.18"
375383
}
376384
},
377385
"nbformat": 4,

0 commit comments

Comments
 (0)