Skip to content

Complete the installation and quick start guide - #123

Merged
ameoli merged 1 commit into
mainfrom
complete-readme
Nov 8, 2026
Merged

ameoli merged 1 commit into
mainfrom
complete-readme

Conversation

@ameoli

@ameoli ameoli commented Nov 8, 2026

Copy link
Copy Markdown
Owner

Describe the alpha version, supported backend and tested Python versions. Walk readers from a fresh checkout to the first HDF5 file and show how to compute a reflectogram with the acquisition’s FFT spacing. Link the configuration, architecture, validation and license pages.

Ran the documented info, validate and run commands with the basic configuration. The HDF5 ADC dataset had shape (1, 2000000), and the Python example returned 1000000 reflectogram bins. Checked the README’s relative links and section anchor.

@ameoli
ameoli merged commit bdc12a8 into main Nov 8, 2026
6 checks passed
@ameoli
ameoli deleted the complete-readme branch November 8, 2026 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant