flits 1.2.2__tar.gz → 1.3.0__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.
- {flits-1.2.2 → flits-1.3.0}/MANIFEST.in +1 -0
- {flits-1.2.2/flits.egg-info → flits-1.3.0}/PKG-INFO +7 -1
- {flits-1.2.2 → flits-1.3.0}/README.md +5 -0
- {flits-1.2.2 → flits-1.3.0}/docs/developer/joss-submission.md +51 -0
- {flits-1.2.2 → flits-1.3.0}/docs/developer/testing.md +15 -0
- flits-1.3.0/docs/user-guide/exports-and-snapshots.md +138 -0
- {flits-1.2.2 → flits-1.3.0}/docs/user-guide/headless-replay.md +6 -3
- {flits-1.2.2 → flits-1.3.0}/flits/__init__.py +1 -1
- {flits-1.2.2 → flits-1.3.0}/flits/cli.py +5 -0
- {flits-1.2.2 → flits-1.3.0}/flits/exports.py +13 -4
- {flits-1.2.2 → flits-1.3.0}/flits/models.py +9 -0
- flits-1.3.0/flits/provenance.py +259 -0
- {flits-1.2.2 → flits-1.3.0}/flits/session.py +88 -3
- {flits-1.2.2 → flits-1.3.0}/flits/web_static/app.js +4 -2
- {flits-1.2.2 → flits-1.3.0/flits.egg-info}/PKG-INFO +7 -1
- flits-1.3.0/flits.egg-info/SOURCES.txt +229 -0
- {flits-1.2.2 → flits-1.3.0}/pyproject.toml +1 -0
- {flits-1.2.2 → flits-1.3.0}/requirements.txt +4 -4
- flits-1.3.0/tests/fixtures/compatibility/README.md +39 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/acf_panel.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/acf_panel.svg +1507 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/catalog.csv +2 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/diagnostics.npz +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/dm_curve.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/dm_curve.svg +1156 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/dynamic_spectrum.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/dynamic_spectrum.svg +1279 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/manifest.json +170 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/power_spectrum.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/power_spectrum.svg +1471 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/profile_diagnostics.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/profile_diagnostics.svg +1899 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/science.json +1311 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/session.json +1136 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/window_native.fil +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/window_native.meta.json +166 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.0/window_native.npz +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/acf_panel.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/acf_panel.svg +1507 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/catalog.csv +2 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/diagnostics.npz +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/dm_curve.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/dm_curve.svg +1156 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/dynamic_spectrum.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/dynamic_spectrum.svg +1279 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/manifest.json +170 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/power_spectrum.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/power_spectrum.svg +1471 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/profile_diagnostics.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/profile_diagnostics.svg +1899 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/science.json +1502 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/session.json +1328 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/window_native.fil +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/window_native.meta.json +168 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v0.2.1/window_native.npz +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/acf_panel.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/acf_panel.svg +1507 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/catalog.csv +2 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/diagnostics.npz +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/dm_curve.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/dm_curve.svg +1156 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/dynamic_spectrum.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/dynamic_spectrum.svg +1279 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/manifest.json +170 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/power_spectrum.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/power_spectrum.svg +1471 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/profile_diagnostics.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/profile_diagnostics.svg +1899 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/science.json +1588 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/session.json +1410 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/window_native.fil +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/window_native.meta.json +184 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.0.0/window_native.npz +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/acf_panel.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/acf_panel.svg +1507 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/catalog.csv +2 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/diagnostics.npz +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/dm_curve.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/dm_curve.svg +1156 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/dynamic_spectrum.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/dynamic_spectrum.svg +1279 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/manifest.json +188 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/power_spectrum.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/power_spectrum.svg +1471 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/profile_diagnostics.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/profile_diagnostics.svg +1899 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/science.json +1607 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/session.json +1424 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/window_native.fil +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/window_native.meta.json +184 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.1.0/window_native.npz +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/acf_panel.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/acf_panel.svg +1507 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/catalog.csv +2 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/diagnostics.npz +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/dm_curve.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/dm_curve.svg +1156 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/dynamic_spectrum.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/dynamic_spectrum.svg +1279 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/manifest.json +206 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/power_spectrum.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/power_spectrum.svg +1471 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/profile_diagnostics.png +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/profile_diagnostics.svg +1899 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/science.json +1626 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/session.json +1433 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/window_native.fil +0 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/window_native.meta.json +184 -0
- flits-1.3.0/tests/fixtures/compatibility/flits-v1.2.1/window_native.npz +0 -0
- flits-1.3.0/tests/fixtures/compatibility/generate.py +126 -0
- flits-1.3.0/tests/fixtures/compatibility/generation.json +529 -0
- flits-1.3.0/tests/fixtures/compatibility/synthetic.fil +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_exports.py +1 -1
- flits-1.3.0/tests/test_historical_compatibility.py +86 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_polarization_reproducibility.py +2 -2
- {flits-1.2.2 → flits-1.3.0}/tests/test_session_snapshots.py +1 -1
- flits-1.3.0/tests/test_software_provenance.py +280 -0
- flits-1.2.2/docs/user-guide/exports-and-snapshots.md +0 -60
- flits-1.2.2/flits.egg-info/SOURCES.txt +0 -132
- {flits-1.2.2 → flits-1.3.0}/LICENSE +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/analysis/dm-optimization.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/analysis/drift.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/analysis/localization.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/analysis/measurements.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/analysis/model-fitting.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/analysis/rm-synthesis.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/analysis/temporal-multiscale.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/analysis/temporal-spectral.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/assets/guided-workflow/dm-sweep.png +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/assets/guided-workflow/export-panel.png +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/assets/guided-workflow/load-session.png +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/assets/guided-workflow/measurement-summary.png +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/assets/guided-workflow/prepared-viewer.png +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/assets/guided-workflow/session-panel.png +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/assets/guided-workflow/temporal-acf.png +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/assets/javascripts/mathjax.js +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/assets/rm-synthesis/rmtools-reference-example.png +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/assets/session-state.svg +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/developer/api-reference.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/developer/custom-readers.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/developer/publishing.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/examples/gbt-reference-requirements.txt +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/examples/gbt-reference-session.json +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/examples/gbt-reference-summary.json +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/examples/rmtools-LICENSE.txt +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/examples/rmtools-reference-input.json +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/examples/rmtools-reference-summary.json +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/getting-started.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/guided-workflow.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/index.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/installation.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/references.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/user-guide/session-workflow.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/docs/user-guide/supported-formats.md +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/__main__.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/__init__.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/dm_optimization/__init__.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/dm_optimization/core.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/drift/__init__.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/drift/core.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/fitting/__init__.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/fitting/fitburst_adapter.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/localization.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/morphology/__init__.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/morphology/widths.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/polarization/__init__.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/polarization/rm_synthesis.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/polarization/workflow.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/spectral/__init__.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/spectral/core.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/temporal/__init__.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/temporal/core.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/analysis/temporal/multiscale.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/io/__init__.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/io/chime.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/io/chime_hdf5_reader.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/io/errors.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/io/filterbank.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/io/psrfits.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/io/reader.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/io/sigproc.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/io/validation.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/io/your_reader.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/measurements.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/settings.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/signal.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/stokes.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/timing.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/web/__init__.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/web/app.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/web_static/index.html +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/web_static/styles.css +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/web_static/vendor/plotly-2.35.2.LICENSE.txt +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits/web_static/vendor/plotly-2.35.2.min.js +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits.egg-info/dependency_links.txt +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits.egg-info/entry_points.txt +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits.egg-info/requires.txt +0 -0
- {flits-1.2.2 → flits-1.3.0}/flits.egg-info/top_level.txt +0 -0
- {flits-1.2.2 → flits-1.3.0}/requirements-dev.txt +0 -0
- {flits-1.2.2 → flits-1.3.0}/requirements-full.txt +0 -0
- {flits-1.2.2 → flits-1.3.0}/setup.cfg +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_calibration.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_cli_replay.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_dedispersion.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_detection.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_dm_optimization.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_drift_analysis.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_frequency_order.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_frontend_e2e.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_frontend_ui_safety.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_frontend_uncertainty_metadata.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_frontend_viewer_styles.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_io_plugin.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_io_readers.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_localization.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_measurements.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_model_fitting.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_polarization_real_data.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_polarization_workflow.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_preprocessing.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_preset_detection.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_rm_synthesis.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_session_io_smoke.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_session_polarization.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_session_smoke.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_spectral_analysis.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_stokes_basis.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_stokes_reader.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_temporal_multiscale.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_timing.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_web_api.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_web_http.py +0 -0
- {flits-1.2.2 → flits-1.3.0}/tests/test_width_analysis.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: flits
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.3.0
|
|
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
|
|
@@ -17,6 +17,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
|
|
|
17
17
|
Classifier: Programming Language :: Python :: 3.11
|
|
18
18
|
Classifier: Programming Language :: Python :: 3.12
|
|
19
19
|
Classifier: Programming Language :: Python :: 3.13
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
20
21
|
Classifier: Operating System :: OS Independent
|
|
21
22
|
Classifier: Topic :: Scientific/Engineering :: Astronomy
|
|
22
23
|
Requires-Python: >=3.11
|
|
@@ -85,6 +86,11 @@ Westerbork, Onsala, Stockert, and CHIME. A common reader interface and configura
|
|
|
85
86
|
telescope presets support analysis across their formats and calibration
|
|
86
87
|
conventions. The session retains the selected state so collaborators can
|
|
87
88
|
reopen it and recompute supported measurements from the original data.
|
|
89
|
+
Snapshots and exports record software versions and available source identities
|
|
90
|
+
for each analysis, preserving the origins of older results during partial
|
|
91
|
+
recomputation. Historical files without this information remain explicitly
|
|
92
|
+
unattributed. See the [preservation guide](https://dirkkuiper.github.io/flits/user-guide/exports-and-snapshots/)
|
|
93
|
+
for environment archiving and compatibility limits.
|
|
88
94
|
|
|
89
95
|
FLITS builds on specialist search, data-processing, and analysis packages. It
|
|
90
96
|
connects measurements through a shared session model with explicit calibration
|
|
@@ -38,6 +38,11 @@ Westerbork, Onsala, Stockert, and CHIME. A common reader interface and configura
|
|
|
38
38
|
telescope presets support analysis across their formats and calibration
|
|
39
39
|
conventions. The session retains the selected state so collaborators can
|
|
40
40
|
reopen it and recompute supported measurements from the original data.
|
|
41
|
+
Snapshots and exports record software versions and available source identities
|
|
42
|
+
for each analysis, preserving the origins of older results during partial
|
|
43
|
+
recomputation. Historical files without this information remain explicitly
|
|
44
|
+
unattributed. See the [preservation guide](https://dirkkuiper.github.io/flits/user-guide/exports-and-snapshots/)
|
|
45
|
+
for environment archiving and compatibility limits.
|
|
41
46
|
|
|
42
47
|
FLITS builds on specialist search, data-processing, and analysis packages. It
|
|
43
48
|
connects measurements through a shared session model with explicit calibration
|
|
@@ -57,6 +57,8 @@ conflicts of interest, and the AI disclosure. Confirm that its statements about
|
|
|
57
57
|
human review and scientific decisions accurately describe the work. The
|
|
58
58
|
disclosure names the known assistants and explicitly records the absence of a
|
|
59
59
|
systematic historical model/version record; it does not invent missing details.
|
|
60
|
+
Record identifiable models and versions for subsequent assistance, and add
|
|
61
|
+
any historical details that can be recovered reliably before submission.
|
|
60
62
|
|
|
61
63
|
The submission form should identify any related science or methods papers,
|
|
62
64
|
including manuscripts in preparation or under review. Retain factual evidence
|
|
@@ -64,6 +66,22 @@ of the research uses described in the paper, such as a project report or
|
|
|
64
66
|
analysis record, in case the editors request it. Confirm credit for any
|
|
65
67
|
additional contributors before submission.
|
|
66
68
|
|
|
69
|
+
### Reproducibility claims
|
|
70
|
+
|
|
71
|
+
Distinguish preservation of stored results from repeating calculations. The
|
|
72
|
+
current session JSON records its schema version, source checksum, settings,
|
|
73
|
+
available results, and software provenance. Each computation has its own
|
|
74
|
+
software identity so reopening or partial recomputation cannot relabel an old
|
|
75
|
+
fit with a new environment. Exports retain this record, including a sidecar for
|
|
76
|
+
SIGPROC windows. Missing historical provenance remains unknown. See
|
|
77
|
+
[Exports and Snapshots](../user-guide/exports-and-snapshots.md) for the
|
|
78
|
+
preservation procedure, source-identity limitations, and replay scope.
|
|
79
|
+
|
|
80
|
+
`tests/test_historical_compatibility.py` reads fixtures generated by five actual
|
|
81
|
+
releases; `tests/fixtures/compatibility/README.md` documents the exact coverage
|
|
82
|
+
and the intentional 0.2.0 uncertainty differences. Do not turn a known change
|
|
83
|
+
in scientific semantics into a claimed guarantee of identical recalculation.
|
|
84
|
+
|
|
67
85
|
## Submission and the final archive
|
|
68
86
|
|
|
69
87
|
Follow the current [JOSS submission requirements](https://joss.readthedocs.io/en/latest/submitting.html)
|
|
@@ -72,8 +90,41 @@ manuscript and software must be available together in the public repository;
|
|
|
72
90
|
a submission branch is allowed. Use the branch containing the final reviewed
|
|
73
91
|
manuscript if it has not yet been merged.
|
|
74
92
|
|
|
93
|
+
Check the current screening rules as well as manuscript formatting: JOSS
|
|
94
|
+
requires more than six months of public development with sustained iteration
|
|
95
|
+
and evidence of actual research use. Old local commit dates alone do not
|
|
96
|
+
establish when a repository became public. Retain evidence of the relevant
|
|
97
|
+
public releases, issues, reviews, and research applications.
|
|
98
|
+
|
|
75
99
|
After review, archive the exact final tagged software release with Zenodo or
|
|
76
100
|
figshare and provide its version and archival DOI. A final archive DOI is not
|
|
77
101
|
required for the initial submission. Preserve the example data, provenance,
|
|
78
102
|
and sharing terms in a suitable archive as well; a GitHub release asset alone
|
|
79
103
|
does not establish that a separate archival deposit exists.
|
|
104
|
+
|
|
105
|
+
## arXiv timing
|
|
106
|
+
|
|
107
|
+
The [JOSS preprint policy](https://joss.readthedocs.io/en/latest/submitting.html#preprint-policy)
|
|
108
|
+
allows preprints before, during, or after review. There is no need to wait for
|
|
109
|
+
JOSS publication. A practical sequence is to finish the technical claims and
|
|
110
|
+
coauthor review, submit to JOSS, and post the agreed manuscript to arXiv around
|
|
111
|
+
the same time. Describe its status accurately; do not label it accepted before
|
|
112
|
+
acceptance. After publication, [add the JOSS DOI and journal reference](https://info.arxiv.org/help/jref.html)
|
|
113
|
+
and [upload a revised version](https://info.arxiv.org/help/replace.html) if the
|
|
114
|
+
text changed during review.
|
|
115
|
+
|
|
116
|
+
Build the clean preprint and upload archive from the same Markdown manuscript:
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
docker pull openjournals/inara@sha256:a0414b8b72fd8923917ede614d340d98dc7aa3102aabc2e955e9c02a6100fd62
|
|
120
|
+
python paper/build_arxiv.py
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
The builder writes `output/arxiv/flits-arxiv-source.zip`, `flits-arxiv.pdf`,
|
|
124
|
+
`main.tex`, and `build-report.json`. It checks the bibliography and compiles
|
|
125
|
+
the exact extracted upload with pdfLaTeX in an isolated container with
|
|
126
|
+
networking disabled. References are embedded in `main.tex`; no external
|
|
127
|
+
bibliography, journal class, or JOSS review watermark is needed at arXiv.
|
|
128
|
+
Upload the ZIP and select pdfLaTeX. Inspect arXiv's own generated preview before
|
|
129
|
+
finalizing; local validation cannot substitute for their server-side checks.
|
|
130
|
+
The report records input/output checksums so a stale preprint can be detected.
|
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# Testing
|
|
2
2
|
|
|
3
|
+
## Saved-file compatibility and software provenance
|
|
4
|
+
|
|
5
|
+
The default suite includes `tests/test_historical_compatibility.py` and
|
|
6
|
+
`tests/test_software_provenance.py`. The former reads checksum-protected
|
|
7
|
+
snapshots and exports produced by five actual releases, checks their stored
|
|
8
|
+
values with independent readers, and compares supported recalculations. See
|
|
9
|
+
`tests/fixtures/compatibility/README.md` for release commits, dependency
|
|
10
|
+
limitations, and the intentional uncertainty changes since 0.2.0. Regenerate
|
|
11
|
+
these fixtures only when deliberately extending the historical baseline.
|
|
12
|
+
|
|
13
|
+
Provenance tests cover changed environments, mixed old and new results,
|
|
14
|
+
unknown historical origins, rejected future schemas, source revisions, and
|
|
15
|
+
metadata in every export format. These checks establish specific compatibility
|
|
16
|
+
evidence; they cannot promise unchanged results under arbitrary future updates.
|
|
17
|
+
|
|
3
18
|
## Full local environment
|
|
4
19
|
|
|
5
20
|
Create a virtual environment and install the full test stack:
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# Exports and Snapshots
|
|
2
|
+
|
|
3
|
+
FLITS supports both export bundles and full session snapshots.
|
|
4
|
+
|
|
5
|
+
## Export bundles
|
|
6
|
+
|
|
7
|
+
Use the export workflow when you want shareable outputs such as:
|
|
8
|
+
|
|
9
|
+
- structured JSON results
|
|
10
|
+
- plots
|
|
11
|
+
- analysis windows
|
|
12
|
+
- catalog-style artifacts
|
|
13
|
+
- array-based products
|
|
14
|
+
|
|
15
|
+
The export preview helps you see what is currently available from the session
|
|
16
|
+
state before downloading anything.
|
|
17
|
+
|
|
18
|
+

|
|
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
|
+
|
|
24
|
+
## Session snapshots
|
|
25
|
+
|
|
26
|
+
Session snapshots capture the analysis state itself rather than just the final
|
|
27
|
+
outputs. They are useful for:
|
|
28
|
+
|
|
29
|
+
- pausing and resuming work
|
|
30
|
+
- sharing a reproducible interactive state
|
|
31
|
+
- archiving the exact crop/mask/selection choices used in an analysis
|
|
32
|
+
|
|
33
|
+
Use **Save Session** to write the current session next to the source data in a
|
|
34
|
+
`snapshots/` folder. If the session was opened from an existing saved snapshot,
|
|
35
|
+
**Save Session** updates that JSON file. Use **Save Copy** when you want a
|
|
36
|
+
timestamped copy instead. The **Saved Sessions** browser can search stored
|
|
37
|
+
snapshots by source, file name, note text, preset, and DM, then reopen a
|
|
38
|
+
matching session directly.
|
|
39
|
+
|
|
40
|
+

|
|
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
|
+
|
|
45
|
+
Snapshots do not embed the raw filterbank data. To share a snapshot with someone
|
|
46
|
+
else, use **Download JSON** or send the saved JSON file and make sure they start
|
|
47
|
+
FLITS with `--data-dir` or `FLITS_DATA_DIR` pointing at a directory that
|
|
48
|
+
contains the same source data file. FLITS records the source file name,
|
|
49
|
+
data-directory-relative path when available, file size, SHA-256 content hash,
|
|
50
|
+
and scientific metadata so the import can find moved/copied data and reject the
|
|
51
|
+
wrong file.
|
|
52
|
+
|
|
53
|
+
## File longevity and software versions
|
|
54
|
+
|
|
55
|
+
Snapshots and science results use JSON; tables use CSV; diagnostic arrays and
|
|
56
|
+
selected windows use NumPy NPZ; plots use PNG/SVG; and selected windows can
|
|
57
|
+
also be exported as SIGPROC `.fil` files with JSON metadata. NPZ products
|
|
58
|
+
contain numeric and string arrays and can be loaded with
|
|
59
|
+
`numpy.load(path, allow_pickle=False)`. These products do not depend on
|
|
60
|
+
pickled Python classes, and stored values can be inspected without running
|
|
61
|
+
the original FLITS analysis.
|
|
62
|
+
|
|
63
|
+
Reading a stored value and recomputing it are different guarantees. A new
|
|
64
|
+
FLITS or dependency version can change a calculation even when the input
|
|
65
|
+
file and selections are identical. JSON or HDF5 alone cannot prevent that.
|
|
66
|
+
|
|
67
|
+
Starting with session schema **1.7** and export schema **1.9**, FLITS captures
|
|
68
|
+
the FLITS and Python versions, operating system and architecture, installed
|
|
69
|
+
package versions (including optional `fitburst`), and available source
|
|
70
|
+
identities. Direct Git installs include their recorded commit; source/archive
|
|
71
|
+
installs include available installer metadata. FLITS source is fingerprinted,
|
|
72
|
+
with its commit and whether its package files are modified when Git is
|
|
73
|
+
available. A schema version identifies the file layout, not this environment.
|
|
74
|
+
|
|
75
|
+
The `software_provenance` record separates the environment saving the file
|
|
76
|
+
(`saved_with`) from the origins of individual `products`. The environment
|
|
77
|
+
records are keyed by a SHA-256 of their contents. Reopening a session or
|
|
78
|
+
recomputing core measurements preserves the original identity of an older
|
|
79
|
+
fit. A failed fit also preserves the provenance of any previously retained
|
|
80
|
+
fit values. Inputs from other analyses retain their own identities. Older
|
|
81
|
+
files without provenance are marked `not_recorded`; a later save does not
|
|
82
|
+
invent their original environment. Replay reports missing or changed
|
|
83
|
+
environments, and the interface notifies you on import or reopening.
|
|
84
|
+
|
|
85
|
+
Science JSON and export manifests carry the full record. CSV has a quoted
|
|
86
|
+
`software_provenance_json` column; NPZ has a JSON string array (or includes
|
|
87
|
+
it in `window_metadata_json`). PNG/SVG store it in their description metadata.
|
|
88
|
+
SIGPROC files must be kept with their `.meta.json` sidecar. Metadata may be
|
|
89
|
+
lost if an external image editor rewrites a plot; preserve the original bundle.
|
|
90
|
+
|
|
91
|
+
Capture occurs once per FLITS process, when its first session is constructed.
|
|
92
|
+
Restart FLITS after changing code or packages. Recorded versions describe
|
|
93
|
+
installed distributions, not a complete binary/container image; source revisions
|
|
94
|
+
can be unavailable for wheels or packages without source metadata. The source
|
|
95
|
+
fingerprint covers Python files, not every native library or data dependency.
|
|
96
|
+
Local source paths and machine hostnames are omitted; direct URLs have their
|
|
97
|
+
userinfo, query, and fragment removed.
|
|
98
|
+
|
|
99
|
+
Compatibility tests use unmodified serializers from releases 0.2.0, 0.2.1,
|
|
100
|
+
1.0.0, 1.1.0, and 1.2.1. Their stored measurements and selections survive
|
|
101
|
+
loading. In this regression example, recomputation matches from 0.2.1 onward;
|
|
102
|
+
0.2.0 has five known uncertainty-field differences introduced by the 0.2.1
|
|
103
|
+
uncertainty-reporting change. Tests also open historical exports with standard
|
|
104
|
+
readers. These tests cover specific fixtures, not every possible analysis or
|
|
105
|
+
future release. Schema 1.0 cached results are deliberately invalidated, and
|
|
106
|
+
unknown future session schemas are rejected before reading the data.
|
|
107
|
+
|
|
108
|
+
## Recommended practice
|
|
109
|
+
|
|
110
|
+
For an analysis you intend to publish, preserve:
|
|
111
|
+
|
|
112
|
+
- The original input data and the session JSON, including its source checksum.
|
|
113
|
+
- The export bundle containing the values, arrays, and plots you actually use.
|
|
114
|
+
- The exact FLITS release or source commit and the analysis environment:
|
|
115
|
+
Python and dependency versions, including the `fitburst` revision if used.
|
|
116
|
+
|
|
117
|
+
For example, run these commands **in the environment that performed the
|
|
118
|
+
analysis**, and keep their outputs beside the snapshot:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
python --version > python-version.txt
|
|
122
|
+
python -m pip freeze --all > environment-requirements.txt
|
|
123
|
+
flits --version > flits-version.txt
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
For editable or local source installs, also record the commit and preserve any
|
|
127
|
+
uncommitted changes; a package version or local path alone does not identify
|
|
128
|
+
that code. Record the operating system and any container image digest used.
|
|
129
|
+
An environment listing is provenance, not a complete archive of the software.
|
|
130
|
+
Repository dependency pins document tested environments but do not automatically
|
|
131
|
+
describe an arbitrary user's installation.
|
|
132
|
+
|
|
133
|
+
Use [headless replay](headless-replay.md) with `--check` to compare the core
|
|
134
|
+
measurements against their saved values. Replay also recomputes recorded width,
|
|
135
|
+
drift, and in-session polarization analyses; the drift settings retain the
|
|
136
|
+
Monte Carlo random seed. It does not rerun optional model fits, DM scans,
|
|
137
|
+
or temporal/spectral structure analyses. Preserve their stored outputs and
|
|
138
|
+
their original environment if you need to repeat them.
|
|
@@ -6,9 +6,12 @@ event window, off-pulse regions, channel mask, spectral extent, calibration
|
|
|
6
6
|
inputs — recomputes the measurements, and can write the same export bundle the
|
|
7
7
|
interface produces.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
Replay makes supported calculations checkable using the snapshot, original
|
|
10
|
+
data, and a compatible software environment. It reports unknown or changed
|
|
11
|
+
software provenance before recomputing. The `--json` report includes these
|
|
12
|
+
warnings and the origins of both recomputed and retained results. A software
|
|
13
|
+
change can alter a calculation; file readability alone does not guarantee
|
|
14
|
+
identical numbers. See [software versions and file longevity](exports-and-snapshots.md#file-longevity-and-software-versions).
|
|
12
15
|
|
|
13
16
|
## Reproduce an analysis
|
|
14
17
|
|
|
@@ -250,6 +250,9 @@ def replay(argv: Sequence[str]) -> int:
|
|
|
250
250
|
_fail(f"Snapshot could not be replayed: {exc}")
|
|
251
251
|
|
|
252
252
|
logger.info("Reopened %s at DM %.6f", session.burst_file, session.dm)
|
|
253
|
+
provenance_warnings = session.provenance_warnings()
|
|
254
|
+
for message in provenance_warnings:
|
|
255
|
+
logger.warning(message)
|
|
253
256
|
|
|
254
257
|
recomputed: list[str] = []
|
|
255
258
|
for key, method_name in _REPLAYABLE_ANALYSES:
|
|
@@ -303,6 +306,8 @@ def replay(argv: Sequence[str]) -> int:
|
|
|
303
306
|
"exported": [str(path) for path in exported],
|
|
304
307
|
"checked": bool(args.check),
|
|
305
308
|
"differences": differences,
|
|
309
|
+
"provenance_warnings": provenance_warnings,
|
|
310
|
+
"software_provenance": session.software_provenance(),
|
|
306
311
|
}
|
|
307
312
|
|
|
308
313
|
if args.as_json:
|
|
@@ -41,7 +41,7 @@ if TYPE_CHECKING:
|
|
|
41
41
|
from flits.session import BurstSession
|
|
42
42
|
|
|
43
43
|
|
|
44
|
-
EXPORT_SCHEMA_VERSION = "1.
|
|
44
|
+
EXPORT_SCHEMA_VERSION = "1.9"
|
|
45
45
|
DEFAULT_EXPORT_INCLUDE = ("json", "csv", "npz", "plots")
|
|
46
46
|
DEFAULT_PLOT_FORMATS = ("png", "svg")
|
|
47
47
|
DEFAULT_WINDOW_FORMATS = ("npz",)
|
|
@@ -114,6 +114,7 @@ class ExportSnapshotData:
|
|
|
114
114
|
selected_channel_end: int
|
|
115
115
|
masked_channels: np.ndarray
|
|
116
116
|
peak_positions_ms: np.ndarray
|
|
117
|
+
software_provenance: dict[str, Any]
|
|
117
118
|
|
|
118
119
|
|
|
119
120
|
@dataclass(frozen=True)
|
|
@@ -287,6 +288,7 @@ def create_export_snapshot(
|
|
|
287
288
|
bundle_name=snapshot.bundle_name,
|
|
288
289
|
schema_version=EXPORT_SCHEMA_VERSION,
|
|
289
290
|
created_at_utc=snapshot.created_at_utc,
|
|
291
|
+
software_provenance=snapshot.software_provenance,
|
|
290
292
|
artifacts=_artifact_objects(
|
|
291
293
|
session_id=session_id,
|
|
292
294
|
export_id=snapshot.export_id,
|
|
@@ -323,6 +325,7 @@ def create_export_snapshot(
|
|
|
323
325
|
bundle_name=snapshot.bundle_name,
|
|
324
326
|
schema_version=EXPORT_SCHEMA_VERSION,
|
|
325
327
|
created_at_utc=snapshot.created_at_utc,
|
|
328
|
+
software_provenance=snapshot.software_provenance,
|
|
326
329
|
artifacts=_artifact_objects(
|
|
327
330
|
session_id=session_id,
|
|
328
331
|
export_id=snapshot.export_id,
|
|
@@ -365,6 +368,7 @@ def _build_snapshot_data(session: BurstSession) -> ExportSnapshotData:
|
|
|
365
368
|
export_id=export_id,
|
|
366
369
|
bundle_name=bundle_name,
|
|
367
370
|
created_at_utc=created_at_utc,
|
|
371
|
+
software_provenance=session.software_provenance(),
|
|
368
372
|
meta=export_meta,
|
|
369
373
|
state=view["state"],
|
|
370
374
|
results=session.results.to_dict() if session.results is not None else None,
|
|
@@ -542,6 +546,7 @@ def _build_window_metadata_payload(snapshot: ExportSnapshotData, window: WindowE
|
|
|
542
546
|
)
|
|
543
547
|
return {
|
|
544
548
|
"schema_version": EXPORT_SCHEMA_VERSION,
|
|
549
|
+
"software_provenance": snapshot.software_provenance,
|
|
545
550
|
"flits_version": __version__,
|
|
546
551
|
"export_id": snapshot.export_id,
|
|
547
552
|
"bundle_name": snapshot.bundle_name,
|
|
@@ -918,7 +923,7 @@ def _materialize_artifact(
|
|
|
918
923
|
figure = plot_figure_cache.get(artifact.plot_key)
|
|
919
924
|
if figure is None:
|
|
920
925
|
raise ValueError(f"Missing plot figure for artifact: {artifact.key}")
|
|
921
|
-
return _figure_bytes(figure, artifact.format)
|
|
926
|
+
return _figure_bytes(figure, artifact.format, provenance=snapshot.software_provenance)
|
|
922
927
|
raise ValueError(f"Unsupported artifact build target: {artifact.build_target}")
|
|
923
928
|
|
|
924
929
|
|
|
@@ -1034,6 +1039,7 @@ def _artifact_objects(
|
|
|
1034
1039
|
def _build_science_json(snapshot: ExportSnapshotData, manifest: ExportManifest) -> bytes:
|
|
1035
1040
|
payload = {
|
|
1036
1041
|
"schema_version": EXPORT_SCHEMA_VERSION,
|
|
1042
|
+
"software_provenance": snapshot.software_provenance,
|
|
1037
1043
|
"flits_version": __version__,
|
|
1038
1044
|
"export_id": snapshot.export_id,
|
|
1039
1045
|
"bundle_name": snapshot.bundle_name,
|
|
@@ -1215,6 +1221,7 @@ def _build_catalog_csv(snapshot: ExportSnapshotData) -> bytes:
|
|
|
1215
1221
|
drift_uncertainty_details.get("component_drift_rate_mhz_per_ms"),
|
|
1216
1222
|
)
|
|
1217
1223
|
)
|
|
1224
|
+
row["software_provenance_json"] = json.dumps(snapshot.software_provenance, sort_keys=True)
|
|
1218
1225
|
buffer = io.StringIO()
|
|
1219
1226
|
writer = csv.DictWriter(buffer, fieldnames=list(row))
|
|
1220
1227
|
writer.writeheader()
|
|
@@ -1224,6 +1231,7 @@ def _build_catalog_csv(snapshot: ExportSnapshotData) -> bytes:
|
|
|
1224
1231
|
|
|
1225
1232
|
def _build_diagnostics_npz(snapshot: ExportSnapshotData) -> bytes:
|
|
1226
1233
|
payload: dict[str, Any] = {
|
|
1234
|
+
"software_provenance_json": np.asarray(json.dumps(snapshot.software_provenance, sort_keys=True), dtype=np.str_),
|
|
1227
1235
|
"dynamic_spectrum": np.asarray(snapshot.dynamic_spectrum, dtype=float),
|
|
1228
1236
|
"time_axis_ms": np.asarray(snapshot.time_axis_ms, dtype=float),
|
|
1229
1237
|
"freq_axis_mhz": np.asarray(snapshot.freq_axis_mhz, dtype=float),
|
|
@@ -1863,9 +1871,10 @@ def _style_colorbar(colorbar: Any) -> None:
|
|
|
1863
1871
|
colorbar.ax.tick_params(color=ASTROFLASH_COLORS["muted"], labelcolor=ASTROFLASH_COLORS["muted"])
|
|
1864
1872
|
|
|
1865
1873
|
|
|
1866
|
-
def _figure_bytes(figure: plt.Figure, fmt: str) -> bytes:
|
|
1874
|
+
def _figure_bytes(figure: plt.Figure, fmt: str, *, provenance: dict[str, Any] | None = None) -> bytes:
|
|
1867
1875
|
buffer = io.BytesIO()
|
|
1868
|
-
|
|
1876
|
+
metadata = None if provenance is None else {"Description": json.dumps(provenance, sort_keys=True)}
|
|
1877
|
+
figure.savefig(buffer, format=fmt, dpi=200, bbox_inches="tight", facecolor="white", metadata=metadata)
|
|
1869
1878
|
return buffer.getvalue()
|
|
1870
1879
|
|
|
1871
1880
|
|
|
@@ -7,12 +7,15 @@ releases."""
|
|
|
7
7
|
|
|
8
8
|
from __future__ import annotations
|
|
9
9
|
|
|
10
|
+
from copy import deepcopy
|
|
10
11
|
from dataclasses import dataclass, field
|
|
11
12
|
from pathlib import Path
|
|
12
13
|
from typing import Any
|
|
13
14
|
|
|
14
15
|
import numpy as np
|
|
15
16
|
|
|
17
|
+
from flits.provenance import validate_session_schema
|
|
18
|
+
|
|
16
19
|
MAX_DRIFT_MONTE_CARLO_TRIALS = 512
|
|
17
20
|
MAX_DRIFT_RANDOM_SEED = 2**64 - 1
|
|
18
21
|
|
|
@@ -2182,10 +2185,12 @@ class AnalysisSessionSnapshot:
|
|
|
2182
2185
|
observatory_longitude_deg: float | None = None
|
|
2183
2186
|
observatory_latitude_deg: float | None = None
|
|
2184
2187
|
observatory_height_m: float | None = None
|
|
2188
|
+
software_provenance: dict[str, Any] | None = None
|
|
2185
2189
|
|
|
2186
2190
|
def to_dict(self) -> dict[str, Any]:
|
|
2187
2191
|
return {
|
|
2188
2192
|
"schema_version": self.schema_version,
|
|
2193
|
+
"software_provenance": deepcopy(self.software_provenance),
|
|
2189
2194
|
"source": self.source.to_dict(),
|
|
2190
2195
|
"dm": float(self.dm),
|
|
2191
2196
|
"preset_key": self.preset_key,
|
|
@@ -2232,8 +2237,10 @@ class AnalysisSessionSnapshot:
|
|
|
2232
2237
|
|
|
2233
2238
|
@classmethod
|
|
2234
2239
|
def from_dict(cls, payload: dict[str, Any]) -> AnalysisSessionSnapshot:
|
|
2240
|
+
validate_session_schema(str(payload.get("schema_version", "1.0")))
|
|
2235
2241
|
return cls(
|
|
2236
2242
|
schema_version=str(payload.get("schema_version", "1.0")),
|
|
2243
|
+
software_provenance=deepcopy(payload.get("software_provenance")),
|
|
2237
2244
|
source=SessionSourceRef.from_dict(payload["source"]),
|
|
2238
2245
|
dm=float(payload["dm"]),
|
|
2239
2246
|
preset_key=str(payload.get("preset_key", "generic")),
|
|
@@ -2318,6 +2325,7 @@ class ExportManifest:
|
|
|
2318
2325
|
schema_version: str
|
|
2319
2326
|
created_at_utc: str
|
|
2320
2327
|
artifacts: list[ExportArtifact]
|
|
2328
|
+
software_provenance: dict[str, Any] | None = None
|
|
2321
2329
|
|
|
2322
2330
|
def to_dict(self) -> dict[str, Any]:
|
|
2323
2331
|
return {
|
|
@@ -2326,6 +2334,7 @@ class ExportManifest:
|
|
|
2326
2334
|
"schema_version": self.schema_version,
|
|
2327
2335
|
"created_at_utc": self.created_at_utc,
|
|
2328
2336
|
"artifacts": [artifact.to_dict() for artifact in self.artifacts],
|
|
2337
|
+
"software_provenance": deepcopy(self.software_provenance),
|
|
2329
2338
|
}
|
|
2330
2339
|
|
|
2331
2340
|
|