85 lines
4.8 KiB
Markdown
85 lines
4.8 KiB
Markdown
# Linear Stage Python Report Instructions
|
|
|
|
The active report workflow is Python-only. Build the Characterization working
|
|
draft from the repository root with:
|
|
|
|
```text
|
|
Build_Characterization_Report.bat
|
|
```
|
|
|
|
The launcher invokes `uv run --script Report/python_script/build_characterization_report.py`.
|
|
It does not use LaTeX, MiKTeX, or a `.tex` source file.
|
|
|
|
## Evidence and boundaries
|
|
|
|
- Write generated reports only in this `Report` folder. Treat `Measurements`,
|
|
`Media`, `Motor`, `Encoder`, `ECMC`, and other evidence folders as read-only.
|
|
- Preserve `python_script/PSI_Logo.png`; the Python report displays this controlled logo on
|
|
page 1.
|
|
- The authoritative input is `../FAT_Checklist.xlsx`. The generator reads the
|
|
Report type, stage identifier, repository URL, coordinate convention, and
|
|
every explicit checklist Yes/No/Remarks response. This workbook is user-owned:
|
|
agents and the generator must never modify it.
|
|
- `Agent_Report_Data.json` is the separate agent-owned data file. Its required
|
|
per-field source paths are governed by `Report_Input_Manifest.json`; the
|
|
fixed generator rejects unmanifested fields or source paths without modifying
|
|
either file.
|
|
- The manifest locks input ownership: ECMC supplies only speed, acceleration,
|
|
PID settings, and test-specific measured positions; Encoder supplies only
|
|
encoder manufacturer/model/protocol/resolution/bit count; Motor supplies
|
|
only motor manufacturer/model/type/step count/resistance; Measurements
|
|
supplies only characterization metrics and environmental min/mean/max
|
|
values. `Measurements/Temperature` is additional temperature data only.
|
|
- Legible, unambiguous information visible in a photograph under `../Media`
|
|
is also valid evidence for encoder, motor, drive, and measurement-system
|
|
fields when the manifest allows it. Cite the exact image under
|
|
`field_sources`; do not infer specifications, calibration state, or installed
|
|
configuration from a model name or an indistinct image.
|
|
- Report table values must contain concise, direct source facts only. Do not
|
|
append evidence commentary, uncertainty statements, interpretations,
|
|
test-status claims, or parenthetical qualifications. Keep traceability in
|
|
`field_sources`, not in the displayed value. For example, enter a configured
|
|
software-limit span as `334 mm configured software-limit span (−1 mm to
|
|
333 mm)`, and enter motor manufacturer and model as their direct values.
|
|
- For Motor data, inspect `../Motor/Motor.xlsx` first when it exists. Use its
|
|
explicitly identified motor record for manufacturer, model, motor type,
|
|
step count, and resistance. Only when a requested field is absent or blank
|
|
there, continue with other documents in `../Motor/`; preserve the exact
|
|
source path for every populated field. Do not use Encoder-folder motor
|
|
fields as a substitute for missing Motor-folder evidence.
|
|
- The agent's work ends after updating `Agent_Report_Data.json` (and only the
|
|
manifest when changing the approved input contract). The agent must
|
|
not run the batch launcher, build a PDF, inspect or validate a PDF, or claim
|
|
that the report is complete, issued, accepted, or visually correct.
|
|
- The user runs `Build_Characterization_Report.bat` and is responsible for
|
|
reviewing the resulting PDF.
|
|
- The generator controls the applicable-standards text and the cover Document
|
|
value. The agent table must not contain those keys: Document is always the
|
|
generated PDF filename, and Applicable standards is fixed to
|
|
`ISO 230-2:2014; ISO 230-2:1997`.
|
|
- The current generator supports `Characterization`. It rejects a workbook
|
|
selecting another report type, contradictory Yes/No cells, and a checklist
|
|
structure that differs from the approved item IDs and wording.
|
|
- Blank responses remain blank. The report never infers a test result, hardware
|
|
identity, calibration state, measurement, or acceptance result.
|
|
- The repository URL is shown only when the workbook contains a complete
|
|
`http://` or `https://` URL. Placeholder text remains blank.
|
|
- Required images use exact basenames `I1` through `I6` in `../Media`. A
|
|
missing image is shown as a visible placeholder; it is not substituted. The
|
|
mapping is fixed: I1 General view, I2 Encoder, I3 Motor, I4 Coupling, I5
|
|
Measurement setup, I6 Measurement setup 2.
|
|
- Every PDF in `../Measurements` is appended in filename order without editing
|
|
its original content.
|
|
|
|
## Validation and status
|
|
|
|
- A successful PDF build is not FAT acceptance or evidence that hardware was
|
|
operated or tested.
|
|
- Inspect the generated PDF page by page before issue review. Confirm the
|
|
cover logo, checklist transfer, image mapping, table wrapping, and every
|
|
appended measurement page.
|
|
- A working draft with missing evidence or placeholders is incomplete and must
|
|
not be issued as an acceptance record.
|
|
|
|
Historical LaTeX templates and tools are retained only under `../OLD/`.
|