Files
2026-11-16 09:31:57 +01:00

34 lines
1.6 KiB
Markdown

# Linear Stage Characterization Report Template
This repository is a reusable, evidence-bound workflow for producing a linear
stage Characterization working-draft PDF. It uses Python to generate the pdf report.
Place project evidence in `ECMC`, `Encoder`, `Motor`, `Measurements`,
`Measurement_System`, and `Media`. Complete `FAT_Checklist.xlsx`, then populate
`Report/python_script/Agent_Report_Data.json` using the source rules in
`Report/python_script/Report_Input_Manifest.json`.
Keep details of mechanical tooling made for the FAT in `Mechanics`. This folder
is outside the report inputs.
Run `Build_Characterization_Report.bat` from the repository root to create:
```text
Report/Linear_Stage_Characterization_Working_Draft.pdf
```
For a table editor, run `Edit_Characterization_Report.bat`. The PyQt5 editor
shows the manifest fields, document fields, and workbook inputs. Checklist
responses are shown as read-only rows. Select another row to edit it. Search
finds text in any column. Yellow marks identify cells edited
in the current session. `Save changes` checks evidence paths and workbook
structure before it saves. Document fields are stored in
`Report/python_script/Report_Settings.json`; workbook inputs remain in
`FAT_Checklist.xlsx`. Enter a PDF filename and select `Create working draft PDF`
to save the data and build a draft in `Report/`. Review the PDF before issue.
The first launch uses `uv` to install the editor and report dependencies in its
local cache.
Read `Report/AGENTS.md` for the detailed evidence and report instructions. The
`Transfer` folder contains a clean starter package for a new project.