flits 1.2.1__tar.gz → 1.2.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (138) hide show
  1. {flits-1.2.1/flits.egg-info → flits-1.2.2}/PKG-INFO +6 -1
  2. {flits-1.2.1 → flits-1.2.2}/README.md +5 -0
  3. {flits-1.2.1 → flits-1.2.2}/docs/analysis/dm-optimization.md +7 -0
  4. {flits-1.2.1 → flits-1.2.2}/docs/analysis/measurements.md +7 -0
  5. {flits-1.2.1 → flits-1.2.2}/docs/analysis/temporal-spectral.md +6 -0
  6. flits-1.2.2/docs/assets/guided-workflow/dm-sweep.png +0 -0
  7. flits-1.2.2/docs/assets/guided-workflow/export-panel.png +0 -0
  8. flits-1.2.2/docs/assets/guided-workflow/load-session.png +0 -0
  9. flits-1.2.2/docs/assets/guided-workflow/measurement-summary.png +0 -0
  10. flits-1.2.2/docs/assets/guided-workflow/prepared-viewer.png +0 -0
  11. flits-1.2.2/docs/assets/guided-workflow/session-panel.png +0 -0
  12. flits-1.2.2/docs/assets/guided-workflow/temporal-acf.png +0 -0
  13. flits-1.2.2/docs/assets/session-state.svg +42 -0
  14. {flits-1.2.1 → flits-1.2.2}/docs/getting-started.md +9 -0
  15. {flits-1.2.1 → flits-1.2.2}/docs/guided-workflow.md +20 -0
  16. {flits-1.2.1 → flits-1.2.2}/docs/index.md +6 -0
  17. {flits-1.2.1 → flits-1.2.2}/docs/user-guide/exports-and-snapshots.md +11 -0
  18. {flits-1.2.1 → flits-1.2.2}/docs/user-guide/session-workflow.md +12 -0
  19. {flits-1.2.1 → flits-1.2.2}/flits/__init__.py +1 -1
  20. {flits-1.2.1 → flits-1.2.2/flits.egg-info}/PKG-INFO +6 -1
  21. {flits-1.2.1 → flits-1.2.2}/flits.egg-info/SOURCES.txt +5 -1
  22. {flits-1.2.1 → flits-1.2.2}/requirements.txt +4 -4
  23. flits-1.2.1/docs/assets/guided-workflow/dm-sweep.png +0 -0
  24. flits-1.2.1/docs/assets/guided-workflow/measurement-summary.png +0 -0
  25. flits-1.2.1/docs/assets/guided-workflow/prepared-viewer.png +0 -0
  26. flits-1.2.1/docs/assets/guided-workflow/session-reproducibility.png +0 -0
  27. {flits-1.2.1 → flits-1.2.2}/LICENSE +0 -0
  28. {flits-1.2.1 → flits-1.2.2}/MANIFEST.in +0 -0
  29. {flits-1.2.1 → flits-1.2.2}/docs/analysis/drift.md +0 -0
  30. {flits-1.2.1 → flits-1.2.2}/docs/analysis/localization.md +0 -0
  31. {flits-1.2.1 → flits-1.2.2}/docs/analysis/model-fitting.md +0 -0
  32. {flits-1.2.1 → flits-1.2.2}/docs/analysis/rm-synthesis.md +0 -0
  33. {flits-1.2.1 → flits-1.2.2}/docs/analysis/temporal-multiscale.md +0 -0
  34. {flits-1.2.1 → flits-1.2.2}/docs/assets/javascripts/mathjax.js +0 -0
  35. {flits-1.2.1 → flits-1.2.2}/docs/assets/rm-synthesis/rmtools-reference-example.png +0 -0
  36. {flits-1.2.1 → flits-1.2.2}/docs/developer/api-reference.md +0 -0
  37. {flits-1.2.1 → flits-1.2.2}/docs/developer/custom-readers.md +0 -0
  38. {flits-1.2.1 → flits-1.2.2}/docs/developer/joss-submission.md +0 -0
  39. {flits-1.2.1 → flits-1.2.2}/docs/developer/publishing.md +0 -0
  40. {flits-1.2.1 → flits-1.2.2}/docs/developer/testing.md +0 -0
  41. {flits-1.2.1 → flits-1.2.2}/docs/examples/gbt-reference-requirements.txt +0 -0
  42. {flits-1.2.1 → flits-1.2.2}/docs/examples/gbt-reference-session.json +0 -0
  43. {flits-1.2.1 → flits-1.2.2}/docs/examples/gbt-reference-summary.json +0 -0
  44. {flits-1.2.1 → flits-1.2.2}/docs/examples/rmtools-LICENSE.txt +0 -0
  45. {flits-1.2.1 → flits-1.2.2}/docs/examples/rmtools-reference-input.json +0 -0
  46. {flits-1.2.1 → flits-1.2.2}/docs/examples/rmtools-reference-summary.json +0 -0
  47. {flits-1.2.1 → flits-1.2.2}/docs/installation.md +0 -0
  48. {flits-1.2.1 → flits-1.2.2}/docs/references.md +0 -0
  49. {flits-1.2.1 → flits-1.2.2}/docs/user-guide/headless-replay.md +0 -0
  50. {flits-1.2.1 → flits-1.2.2}/docs/user-guide/supported-formats.md +0 -0
  51. {flits-1.2.1 → flits-1.2.2}/flits/__main__.py +0 -0
  52. {flits-1.2.1 → flits-1.2.2}/flits/analysis/__init__.py +0 -0
  53. {flits-1.2.1 → flits-1.2.2}/flits/analysis/dm_optimization/__init__.py +0 -0
  54. {flits-1.2.1 → flits-1.2.2}/flits/analysis/dm_optimization/core.py +0 -0
  55. {flits-1.2.1 → flits-1.2.2}/flits/analysis/drift/__init__.py +0 -0
  56. {flits-1.2.1 → flits-1.2.2}/flits/analysis/drift/core.py +0 -0
  57. {flits-1.2.1 → flits-1.2.2}/flits/analysis/fitting/__init__.py +0 -0
  58. {flits-1.2.1 → flits-1.2.2}/flits/analysis/fitting/fitburst_adapter.py +0 -0
  59. {flits-1.2.1 → flits-1.2.2}/flits/analysis/localization.py +0 -0
  60. {flits-1.2.1 → flits-1.2.2}/flits/analysis/morphology/__init__.py +0 -0
  61. {flits-1.2.1 → flits-1.2.2}/flits/analysis/morphology/widths.py +0 -0
  62. {flits-1.2.1 → flits-1.2.2}/flits/analysis/polarization/__init__.py +0 -0
  63. {flits-1.2.1 → flits-1.2.2}/flits/analysis/polarization/rm_synthesis.py +0 -0
  64. {flits-1.2.1 → flits-1.2.2}/flits/analysis/polarization/workflow.py +0 -0
  65. {flits-1.2.1 → flits-1.2.2}/flits/analysis/spectral/__init__.py +0 -0
  66. {flits-1.2.1 → flits-1.2.2}/flits/analysis/spectral/core.py +0 -0
  67. {flits-1.2.1 → flits-1.2.2}/flits/analysis/temporal/__init__.py +0 -0
  68. {flits-1.2.1 → flits-1.2.2}/flits/analysis/temporal/core.py +0 -0
  69. {flits-1.2.1 → flits-1.2.2}/flits/analysis/temporal/multiscale.py +0 -0
  70. {flits-1.2.1 → flits-1.2.2}/flits/cli.py +0 -0
  71. {flits-1.2.1 → flits-1.2.2}/flits/exports.py +0 -0
  72. {flits-1.2.1 → flits-1.2.2}/flits/io/__init__.py +0 -0
  73. {flits-1.2.1 → flits-1.2.2}/flits/io/chime.py +0 -0
  74. {flits-1.2.1 → flits-1.2.2}/flits/io/chime_hdf5_reader.py +0 -0
  75. {flits-1.2.1 → flits-1.2.2}/flits/io/errors.py +0 -0
  76. {flits-1.2.1 → flits-1.2.2}/flits/io/filterbank.py +0 -0
  77. {flits-1.2.1 → flits-1.2.2}/flits/io/psrfits.py +0 -0
  78. {flits-1.2.1 → flits-1.2.2}/flits/io/reader.py +0 -0
  79. {flits-1.2.1 → flits-1.2.2}/flits/io/sigproc.py +0 -0
  80. {flits-1.2.1 → flits-1.2.2}/flits/io/validation.py +0 -0
  81. {flits-1.2.1 → flits-1.2.2}/flits/io/your_reader.py +0 -0
  82. {flits-1.2.1 → flits-1.2.2}/flits/measurements.py +0 -0
  83. {flits-1.2.1 → flits-1.2.2}/flits/models.py +0 -0
  84. {flits-1.2.1 → flits-1.2.2}/flits/session.py +0 -0
  85. {flits-1.2.1 → flits-1.2.2}/flits/settings.py +0 -0
  86. {flits-1.2.1 → flits-1.2.2}/flits/signal.py +0 -0
  87. {flits-1.2.1 → flits-1.2.2}/flits/stokes.py +0 -0
  88. {flits-1.2.1 → flits-1.2.2}/flits/timing.py +0 -0
  89. {flits-1.2.1 → flits-1.2.2}/flits/web/__init__.py +0 -0
  90. {flits-1.2.1 → flits-1.2.2}/flits/web/app.py +0 -0
  91. {flits-1.2.1 → flits-1.2.2}/flits/web_static/app.js +0 -0
  92. {flits-1.2.1 → flits-1.2.2}/flits/web_static/index.html +0 -0
  93. {flits-1.2.1 → flits-1.2.2}/flits/web_static/styles.css +0 -0
  94. {flits-1.2.1 → flits-1.2.2}/flits/web_static/vendor/plotly-2.35.2.LICENSE.txt +0 -0
  95. {flits-1.2.1 → flits-1.2.2}/flits/web_static/vendor/plotly-2.35.2.min.js +0 -0
  96. {flits-1.2.1 → flits-1.2.2}/flits.egg-info/dependency_links.txt +0 -0
  97. {flits-1.2.1 → flits-1.2.2}/flits.egg-info/entry_points.txt +0 -0
  98. {flits-1.2.1 → flits-1.2.2}/flits.egg-info/requires.txt +0 -0
  99. {flits-1.2.1 → flits-1.2.2}/flits.egg-info/top_level.txt +0 -0
  100. {flits-1.2.1 → flits-1.2.2}/pyproject.toml +0 -0
  101. {flits-1.2.1 → flits-1.2.2}/requirements-dev.txt +0 -0
  102. {flits-1.2.1 → flits-1.2.2}/requirements-full.txt +0 -0
  103. {flits-1.2.1 → flits-1.2.2}/setup.cfg +0 -0
  104. {flits-1.2.1 → flits-1.2.2}/tests/test_calibration.py +0 -0
  105. {flits-1.2.1 → flits-1.2.2}/tests/test_cli_replay.py +0 -0
  106. {flits-1.2.1 → flits-1.2.2}/tests/test_dedispersion.py +0 -0
  107. {flits-1.2.1 → flits-1.2.2}/tests/test_detection.py +0 -0
  108. {flits-1.2.1 → flits-1.2.2}/tests/test_dm_optimization.py +0 -0
  109. {flits-1.2.1 → flits-1.2.2}/tests/test_drift_analysis.py +0 -0
  110. {flits-1.2.1 → flits-1.2.2}/tests/test_exports.py +0 -0
  111. {flits-1.2.1 → flits-1.2.2}/tests/test_frequency_order.py +0 -0
  112. {flits-1.2.1 → flits-1.2.2}/tests/test_frontend_e2e.py +0 -0
  113. {flits-1.2.1 → flits-1.2.2}/tests/test_frontend_ui_safety.py +0 -0
  114. {flits-1.2.1 → flits-1.2.2}/tests/test_frontend_uncertainty_metadata.py +0 -0
  115. {flits-1.2.1 → flits-1.2.2}/tests/test_frontend_viewer_styles.py +0 -0
  116. {flits-1.2.1 → flits-1.2.2}/tests/test_io_plugin.py +0 -0
  117. {flits-1.2.1 → flits-1.2.2}/tests/test_io_readers.py +0 -0
  118. {flits-1.2.1 → flits-1.2.2}/tests/test_localization.py +0 -0
  119. {flits-1.2.1 → flits-1.2.2}/tests/test_measurements.py +0 -0
  120. {flits-1.2.1 → flits-1.2.2}/tests/test_model_fitting.py +0 -0
  121. {flits-1.2.1 → flits-1.2.2}/tests/test_polarization_real_data.py +0 -0
  122. {flits-1.2.1 → flits-1.2.2}/tests/test_polarization_reproducibility.py +0 -0
  123. {flits-1.2.1 → flits-1.2.2}/tests/test_polarization_workflow.py +0 -0
  124. {flits-1.2.1 → flits-1.2.2}/tests/test_preprocessing.py +0 -0
  125. {flits-1.2.1 → flits-1.2.2}/tests/test_preset_detection.py +0 -0
  126. {flits-1.2.1 → flits-1.2.2}/tests/test_rm_synthesis.py +0 -0
  127. {flits-1.2.1 → flits-1.2.2}/tests/test_session_io_smoke.py +0 -0
  128. {flits-1.2.1 → flits-1.2.2}/tests/test_session_polarization.py +0 -0
  129. {flits-1.2.1 → flits-1.2.2}/tests/test_session_smoke.py +0 -0
  130. {flits-1.2.1 → flits-1.2.2}/tests/test_session_snapshots.py +0 -0
  131. {flits-1.2.1 → flits-1.2.2}/tests/test_spectral_analysis.py +0 -0
  132. {flits-1.2.1 → flits-1.2.2}/tests/test_stokes_basis.py +0 -0
  133. {flits-1.2.1 → flits-1.2.2}/tests/test_stokes_reader.py +0 -0
  134. {flits-1.2.1 → flits-1.2.2}/tests/test_temporal_multiscale.py +0 -0
  135. {flits-1.2.1 → flits-1.2.2}/tests/test_timing.py +0 -0
  136. {flits-1.2.1 → flits-1.2.2}/tests/test_web_api.py +0 -0
  137. {flits-1.2.1 → flits-1.2.2}/tests/test_web_http.py +0 -0
  138. {flits-1.2.1 → flits-1.2.2}/tests/test_width_analysis.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: flits
3
- Version: 1.2.1
3
+ Version: 1.2.2
4
4
  Summary: Browser-based FRB burst analysis software (SIGPROC, PSRFITS, CHIME/FRB HDF5)
5
5
  Author: Dirk Kuiper
6
6
  License-Expression: GPL-3.0-only
@@ -68,6 +68,11 @@ The selected analysis state is recorded in a JSON session snapshot. Given
68
68
  the snapshot and original data, `flits replay` restores the selections and
69
69
  recomputes supported measurements without a browser.
70
70
 
71
+ ![FLITS aligned viewer showing a GBT burst with its time profile, dynamic spectrum, frequency profile, and selected event, off-pulse, and spectral windows.](docs/assets/guided-workflow/prepared-viewer.png)
72
+
73
+ The [guided GBT workflow](https://dirkkuiper.github.io/flits/guided-workflow/)
74
+ walks through the selections and results shown in the interface.
75
+
71
76
  ## Why FLITS exists
72
77
 
73
78
  Measuring a detected burst involves selecting an event window and noise
@@ -21,6 +21,11 @@ The selected analysis state is recorded in a JSON session snapshot. Given
21
21
  the snapshot and original data, `flits replay` restores the selections and
22
22
  recomputes supported measurements without a browser.
23
23
 
24
+ ![FLITS aligned viewer showing a GBT burst with its time profile, dynamic spectrum, frequency profile, and selected event, off-pulse, and spectral windows.](docs/assets/guided-workflow/prepared-viewer.png)
25
+
26
+ The [guided GBT workflow](https://dirkkuiper.github.io/flits/guided-workflow/)
27
+ walks through the selections and results shown in the interface.
28
+
24
29
  ## Why FLITS exists
25
30
 
26
31
  Measuring a detected burst involves selecting an event window and noise
@@ -105,6 +105,13 @@ That state is what the session snapshot records.
105
105
 
106
106
  ## Reading the result
107
107
 
108
+ ![DMphase score curve and residual arrival time plots from the guided GBT example.](../assets/guided-workflow/dm-sweep.png)
109
+
110
+ *The DMphase curve peaks near a residual DM of 5.5 on the sampled grid; the
111
+ weighted fit reports about 5.41. The lower plot compares sub-band arrival-time
112
+ residuals at the applied and fitted DMs. See the [GBT guided workflow](../guided-workflow.md)
113
+ for the inputs and interpretation limits of this example.*
114
+
108
115
  | Output | What to look at |
109
116
  | --- | --- |
110
117
  | Score curve | Should have a clear single maximum. Multiple comparable peaks mean the metric cannot distinguish them. |
@@ -2,6 +2,13 @@
2
2
 
3
3
  FLITS reports measurements from the current prepared session state.
4
4
 
5
+ ![Prepare tab showing selected windows, headline measurements, signal metrics, and uncertainty flags for the GBT tutorial burst.](../assets/guided-workflow/measurement-summary.png)
6
+
7
+ *The Prepare tab groups selection readiness, headline measurements, timing
8
+ details, and uncertainty flags. These values come from the [GBT guided
9
+ workflow](../guided-workflow.md); its absolute TOA fields are not part of the
10
+ validated reference calculation.*
11
+
5
12
  ## Core outputs
6
13
 
7
14
  The measurement workflow can report:
@@ -53,6 +53,12 @@ is built to remove exactly this S/N dependence.
53
53
 
54
54
  ## ACF widths are not durations
55
55
 
56
+ ![Temporal and spectral autocorrelation functions for the guided GBT burst, with a dashed half-maximum reference line.](../assets/guided-workflow/temporal-acf.png)
57
+
58
+ *The dashed line marks normalized ACF = 0.5. Its intersections with the curves
59
+ give self-similarity widths in time and frequency for the [GBT example](../guided-workflow.md),
60
+ not the manually selected event duration.*
61
+
56
62
  An ACF width is a self-similarity scale. It is a good way to compare coherence
57
63
  structure between bursts or between time and frequency, but it is not
58
64
  interchangeable with the full burst duration, and the two can differ by a large
@@ -0,0 +1,42 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" width="1040" height="270" viewBox="0 0 1040 270" role="img" aria-labelledby="title description">
2
+ <title id="title">How one FLITS session carries selections into analysis and export</title>
3
+ <desc id="description">A source file and applied DM lead to prepared crop, event, off-pulse, spectral, and mask selections. Those shared selections feed measurements and specialist analysis tabs. Results and selections can then be saved as a session snapshot or exported as products.</desc>
4
+ <defs>
5
+ <marker id="arrow" markerWidth="10" markerHeight="10" refX="8" refY="5" orient="auto">
6
+ <path d="M1 1 L9 5 L1 9" fill="none" stroke="#5c358a" stroke-width="2"/>
7
+ </marker>
8
+ </defs>
9
+ <rect width="1040" height="270" rx="18" fill="#faf8fd"/>
10
+ <g font-family="Arial, Helvetica, sans-serif" fill="#252132">
11
+ <rect x="24" y="56" width="182" height="160" rx="14" fill="#fff" stroke="#d9cfe9" stroke-width="2"/>
12
+ <text x="44" y="94" font-size="22" font-weight="700">Load</text>
13
+ <text x="44" y="127" font-size="16">Source file</text>
14
+ <text x="44" y="152" font-size="16">Applied DM</text>
15
+ <text x="44" y="177" font-size="16">Preset / calibration</text>
16
+
17
+ <rect x="244" y="32" width="245" height="208" rx="14" fill="#f1e9fa" stroke="#9e7ac4" stroke-width="2"/>
18
+ <text x="264" y="70" font-size="22" font-weight="700">Prepare</text>
19
+ <text x="264" y="104" font-size="16">Crop + event window</text>
20
+ <text x="264" y="129" font-size="16">Off-pulse windows</text>
21
+ <text x="264" y="154" font-size="16">Spectral window</text>
22
+ <text x="264" y="179" font-size="16">Channel mask</text>
23
+ <text x="264" y="211" font-size="13" fill="#5c358a">Shared session state</text>
24
+
25
+ <rect x="528" y="56" width="232" height="160" rx="14" fill="#fff" stroke="#d9cfe9" stroke-width="2"/>
26
+ <text x="548" y="94" font-size="22" font-weight="700">Analyze</text>
27
+ <text x="548" y="127" font-size="16">Compute measurements</text>
28
+ <text x="548" y="152" font-size="16">DM / Temporal / Drift</text>
29
+ <text x="548" y="177" font-size="16">Fitting / Polarization</text>
30
+
31
+ <rect x="799" y="56" width="217" height="160" rx="14" fill="#fff" stroke="#d9cfe9" stroke-width="2"/>
32
+ <text x="819" y="94" font-size="22" font-weight="700">Keep results</text>
33
+ <text x="819" y="127" font-size="16">Save session snapshot</text>
34
+ <text x="819" y="152" font-size="16">Download JSON</text>
35
+ <text x="819" y="177" font-size="16">Build export bundle</text>
36
+ </g>
37
+ <g fill="none" stroke="#5c358a" stroke-width="2.5" marker-end="url(#arrow)">
38
+ <path d="M207 136 H236"/>
39
+ <path d="M490 136 H519"/>
40
+ <path d="M761 136 H790"/>
41
+ </g>
42
+ </svg>
@@ -25,6 +25,10 @@ flits --data-dir /path/to/filterbanks --host 127.0.0.1 --port 8123
25
25
 
26
26
  Open `http://127.0.0.1:8123`.
27
27
 
28
+ The browser opens with a **New Session** form. Choose the source file and DM
29
+ there, then use **Load Session**. The **Session** panel in the left sidebar is
30
+ for saving or reopening a session after it has loaded.
31
+
28
32
  ## 3. Load a burst file
29
33
 
30
34
  FLITS reads SIGPROC filterbank (`.fil`), PSRFITS search/fold data (`.fits`,
@@ -45,6 +49,11 @@ If FLITS can identify the observing setup, it may populate default calibration
45
49
  values such as SEFD. If it cannot, use the generic preset or set an explicit
46
50
  SEFD yourself.
47
51
 
52
+ ![New Session form with the tutorial filterbank selected, DM set to zero, the GBT preset, and the Load Session button.](assets/guided-workflow/load-session.png)
53
+
54
+ *The New Session form for the [GBT example](guided-workflow.md). For your own
55
+ data, choose your file and its appropriate DM before loading.*
56
+
48
57
  ## 4. Work through the session
49
58
 
50
59
  The typical order is:
@@ -65,6 +65,13 @@ The off-pulse windows are separate from the event and set the background and
65
65
  noise estimates. FLITS quantizes selections to available bins, so the measured
66
66
  event duration and bandwidth differ slightly from the requested bounds.
67
67
 
68
+ ![Aligned viewer with the GBT burst near 240 ms, event and off-pulse windows on the time profile, and a 1300–1750 MHz spectral window on the waterfall and frequency profile.](assets/guided-workflow/prepared-viewer.png)
69
+
70
+ *Prepared GBT selection. The narrow blue band around the burst is the event
71
+ window; the pale blue regions on either side are off-pulse references. Purple
72
+ horizontal lines delimit the spectral window. White horizontal streaks in the
73
+ waterfall are visible interference; this reference intentionally uses no mask.*
74
+
68
75
  ## 4. Compute measurements
69
76
 
70
77
  Click **Compute**. The full-precision outputs are in the downloadable
@@ -88,6 +95,13 @@ limitation of the example. Supply an independently justified calibration and
88
95
  its uncertainty before interpreting these as fully calibrated scientific
89
96
  measurements. The reference does not supply a source distance or redshift.
90
97
 
98
+ ![FLITS Prepare tab showing the GBT selection, measurement cards, signal metrics, and uncertainty flags.](assets/guided-workflow/measurement-summary.png)
99
+
100
+ *The Prepare tab connects the selected windows to the measured quantities.
101
+ Fluence and peak flux carry a “Statistical only” label because this example
102
+ does not provide an SEFD uncertainty. The displayed TOA fields are outside
103
+ the validated reference checks for this already-dedispersed cutout.*
104
+
91
105
  ## 5. Run a residual DM sweep
92
106
 
93
107
  In the **DM** tab, select **DMphase**, center `0`, half range `10`, and step
@@ -99,6 +113,12 @@ best-fit value changes the data used for the measurements above. This sweep
99
113
  demonstrates the diagnostic and does not establish a new astrophysical DM for
100
114
  the source.
101
115
 
116
+ ![DMphase tab showing a sweep centered at zero with a sampled peak at 5.5 and fitted best residual DM near 5.41, plus sub-band residual-arrival-time diagnostics.](assets/guided-workflow/dm-sweep.png)
117
+
118
+ *Read the score curve together with the residual diagnostics below it. The
119
+ sampled peak and fitted best DM are distinct. This screenshot illustrates the
120
+ residual sweep; the exact reference values are in the downloadable summary.*
121
+
102
122
  ## 6. Save and replay the session
103
123
 
104
124
  **Save Session** stores the current state in the local snapshot library;
@@ -9,6 +9,12 @@ formats include SIGPROC filterbank (`.fil`), PSRFITS search/fold data
9
9
  catalog waterfalls and beamformed `BBData` power files, extensible via a
10
10
  plugin-based reader framework.
11
11
 
12
+ ![FLITS aligned viewer showing a GBT burst, its time profile, dynamic spectrum, frequency profile, event and off-pulse windows, and selected spectral band.](assets/guided-workflow/prepared-viewer.png)
13
+
14
+ *The aligned viewer in the [GBT guided workflow](guided-workflow.md). Blue marks
15
+ the event and off-pulse time windows; purple lines mark the selected frequency
16
+ range. The three plots share the same selection state.*
17
+
12
18
  ## Why FLITS exists
13
19
 
14
20
  Measuring a detected burst involves selecting an event window and noise
@@ -15,6 +15,12 @@ Use the export workflow when you want shareable outputs such as:
15
15
  The export preview helps you see what is currently available from the session
16
16
  state before downloading anything.
17
17
 
18
+ ![FLITS Export tab with Science JSON selected in the export planner and the corresponding artifact in the preview.](../assets/guided-workflow/export-panel.png)
19
+
20
+ *Choose output types on the left and inspect the exact artifact list on the
21
+ right. **Build Export Bundle** creates the selected products from the current
22
+ session state.*
23
+
18
24
  ## Session snapshots
19
25
 
20
26
  Session snapshots capture the analysis state itself rather than just the final
@@ -31,6 +37,11 @@ timestamped copy instead. The **Saved Sessions** browser can search stored
31
37
  snapshots by source, file name, note text, preset, and DM, then reopen a
32
38
  matching session directly.
33
39
 
40
+ ![FLITS Session sidebar showing Save Session, Save Copy, Download JSON, Upload JSON, and the Saved Sessions browser.](../assets/guided-workflow/session-panel.png)
41
+
42
+ *The Session panel saves or reopens the full interactive state. **Download JSON**
43
+ makes a portable snapshot; the Export tab above builds derived artifacts.*
44
+
34
45
  Snapshots do not embed the raw filterbank data. To share a snapshot with someone
35
46
  else, use **Download JSON** or send the saved JSON file and make sure they start
36
47
  FLITS with `--data-dir` or `FLITS_DATA_DIR` pointing at a directory that
@@ -4,6 +4,11 @@ FLITS is centered on the current session state. Most analysis products depend on
4
4
  the same crop window, event window, off-pulse definition, spectral window, and
5
5
  mask selection.
6
6
 
7
+ ![Diagram of a FLITS session: source data and DM feed prepared selections, which feed measurements and analysis tabs, then exports and snapshots.](../assets/session-state.svg)
8
+
9
+ *The preparation state is shared by the measurement and analysis tabs. Save a
10
+ snapshot when you want to preserve the selections as well as the results.*
11
+
7
12
  ## Typical order of operations
8
13
 
9
14
  1. Load a filterbank and DM.
@@ -30,6 +35,13 @@ Use the Prepare workflow to set the core analysis state:
30
35
 
31
36
  This state feeds the later analysis tabs.
32
37
 
38
+ ![GBT burst in the aligned viewer with time, waterfall, and frequency profiles and marked event, off-pulse, and spectral selections.](../assets/guided-workflow/prepared-viewer.png)
39
+
40
+ *The top plot is the time profile, the middle plot is the dynamic spectrum, and
41
+ the plot at right is the frequency profile. Select an interaction mode above
42
+ the plots, then click the plot to set its bounds. **Exact Selection** below the
43
+ toolbar accepts coordinates directly when you need reproducible boundaries.*
44
+
33
45
  ## Measurement mindset
34
46
 
35
47
  A good workflow is to make the preparation state explicit before interpreting
@@ -5,7 +5,7 @@ from __future__ import annotations
5
5
  import importlib
6
6
  from typing import TYPE_CHECKING
7
7
 
8
- __version__ = "1.2.1"
8
+ __version__ = "1.2.2"
9
9
 
10
10
  __all__ = [
11
11
  "BurstMeasurements",
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: flits
3
- Version: 1.2.1
3
+ Version: 1.2.2
4
4
  Summary: Browser-based FRB burst analysis software (SIGPROC, PSRFITS, CHIME/FRB HDF5)
5
5
  Author: Dirk Kuiper
6
6
  License-Expression: GPL-3.0-only
@@ -68,6 +68,11 @@ The selected analysis state is recorded in a JSON session snapshot. Given
68
68
  the snapshot and original data, `flits replay` restores the selections and
69
69
  recomputes supported measurements without a browser.
70
70
 
71
+ ![FLITS aligned viewer showing a GBT burst with its time profile, dynamic spectrum, frequency profile, and selected event, off-pulse, and spectral windows.](docs/assets/guided-workflow/prepared-viewer.png)
72
+
73
+ The [guided GBT workflow](https://dirkkuiper.github.io/flits/guided-workflow/)
74
+ walks through the selections and results shown in the interface.
75
+
71
76
  ## Why FLITS exists
72
77
 
73
78
  Measuring a detected burst involves selecting an event window and noise
@@ -18,10 +18,14 @@ docs/analysis/model-fitting.md
18
18
  docs/analysis/rm-synthesis.md
19
19
  docs/analysis/temporal-multiscale.md
20
20
  docs/analysis/temporal-spectral.md
21
+ docs/assets/session-state.svg
21
22
  docs/assets/guided-workflow/dm-sweep.png
23
+ docs/assets/guided-workflow/export-panel.png
24
+ docs/assets/guided-workflow/load-session.png
22
25
  docs/assets/guided-workflow/measurement-summary.png
23
26
  docs/assets/guided-workflow/prepared-viewer.png
24
- docs/assets/guided-workflow/session-reproducibility.png
27
+ docs/assets/guided-workflow/session-panel.png
28
+ docs/assets/guided-workflow/temporal-acf.png
25
29
  docs/assets/javascripts/mathjax.js
26
30
  docs/assets/rm-synthesis/rmtools-reference-example.png
27
31
  docs/developer/api-reference.md
@@ -8,13 +8,13 @@
8
8
  # pip install -c requirements.txt .
9
9
  #
10
10
  # Dependabot keeps these pins current.
11
- fastapi==0.139.2
12
- uvicorn==0.51.0
11
+ fastapi==0.141.1
12
+ uvicorn==0.53.0
13
13
  numpy==2.4.6
14
14
  scipy==1.17.1
15
15
  astropy==8.0.1
16
- pydantic==2.13.4
16
+ pydantic==2.13.5
17
17
  your==0.6.7
18
18
  jess==0.3.1
19
- matplotlib==3.11.1
19
+ matplotlib==3.11.2
20
20
  h5py==3.16.0
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes