Template
up
This commit is contained in:
1 parent
af86be71bd
commit
caa04e59e8
22 files changed
+36
-19
No files matched your search
+1
-1
@@ -1 +1 @@
|
||||
/Template-Kivel
|
||||
/Report/unused/reference/Template-Kivel
|
||||
@@ -1,12 +1,14 @@
|
||||
# Linear-stage report project guidance
|
||||
|
||||
This repository holds source evidence and a project-specific FAT or characterization report. Before
|
||||
report work, read `Report/AGENTS.md` completely. It defines the two templates,
|
||||
This repository is the reusable baseline for future linear-stage FAT or
|
||||
characterization projects. A derived project repository holds the source
|
||||
evidence and its project-specific report. Before report work in a derived
|
||||
project, read `Report/AGENTS.md` completely. It defines the two templates,
|
||||
evidence rules, blank checklists, image mapping, appendices and final QA.
|
||||
|
||||
## Boundaries and evidence
|
||||
|
||||
- During report generation, write only inside `Report/`. Treat `Measurements`,
|
||||
- During report generation in a derived project, write only inside `Report/`. Treat `Measurements`,
|
||||
`Media`, `Motor`, `Encoder`, `ECMC` and other evidence folders as read-only.
|
||||
- Do not execute ECMC example commands or operate hardware to prepare a report.
|
||||
- Preserve original filenames, photographs, raw data and measurement PDFs.
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# ECMC evidence
|
||||
|
||||
Use this folder for project-specific ECMC configuration, controller settings,
|
||||
revision records, and relevant logs. Preserve exact filenames and distinguish
|
||||
configured or commanded values from measured stage behavior.
|
||||
|
||||
Command examples and configuration files are evidence only during report
|
||||
preparation. Do not execute them to generate a report or infer that hardware
|
||||
behavior has been verified.
|
||||
|
||||
The report instructions are in [`../Report/AGENTS.md`](../Report/AGENTS.md).
|
||||
Binary file not shown.
@@ -9,7 +9,7 @@ This repository is a starting point for preparing a project-specific factory acc
|
||||
- [`Media/`](Media/) — the six report images, named exactly `I1` through `I6` with `.jpg`, `.jpeg`, `.png`, or `.pdf` extensions.
|
||||
- [`Motor/`](Motor/) — motor or actuator identification and supporting project evidence.
|
||||
- [`Encoder/`](Encoder/) — encoder identification and supporting project evidence.
|
||||
- [`ECMC/`](ECMC/) — project-specific ECMC configuration and notes, if applicable. `runCommands.txt` contains example commands and host paths; verify and adapt them before use.
|
||||
- [`ECMC/`](ECMC/) — project-specific ECMC configuration and notes, if applicable. Treat supplied configuration and command records as evidence; do not execute them during report preparation.
|
||||
|
||||
## Start a new FAT repository
|
||||
|
||||
@@ -19,8 +19,8 @@ This repository is a starting point for preparing a project-specific factory acc
|
||||
4. Add the measurement and analysis PDFs to `Measurements/`. Keep original evidence files intact.
|
||||
5. Read [`Report/AGENTS.md`](Report/AGENTS.md) before creating or updating a report. It defines the evidence requirements, template-selection rules, compilation, and page-by-page visual validation workflow.
|
||||
6. Select `FAT` or `Characterization` in the workbook. The agent then uses `Linear_Stage_FAT_Report_Template.tex` or `Linear_Stage_Characterization_Report_Template.tex` directly; the templates contain no report-type switch.
|
||||
7. Complete [`FAT_Checklist.xlsx`](FAT_Checklist.xlsx) during the test. Select the report type on `Read Me`, preserve item IDs and wording, select at most one Yes/No response per item, and add factual remarks or evidence references where useful. Confirm or edit the project axis convention in the same sheet. Provide the saved workbook for report update.
|
||||
8. The agent transfers user-entered responses, remarks, report type, and coordinate convention into the project-specific report, then validates it according to `Report/AGENTS.md`. Blank responses remain blank and are not inferred.
|
||||
7. Complete [`FAT_Checklist.xlsx`](FAT_Checklist.xlsx) during the test. On `Read Me`, select the report type, enter the exact stage identifier as text (for example `0001`), and confirm or edit the project axis convention. Preserve checklist item IDs and wording, select at most one Yes/No response per item, and add factual remarks or evidence references where useful. Provide the saved workbook for report update.
|
||||
8. The agent transfers user-entered responses, remarks, report type, stage identifier, and coordinate convention into the project-specific report, then validates it according to `Report/AGENTS.md`. Blank responses remain blank and are not inferred.
|
||||
|
||||
The templates are not evidence that a particular stage has been tested or accepted. FAT dispositions require applicable acceptance criteria and traceable results, calibration, and uncertainty evidence. Characterization reports present test scope, methods, results, uncertainty, and observations without acceptance criteria or a Conclusions section.
|
||||
|
||||
@@ -40,3 +40,7 @@ A working draft with missing evidence is not an issued report or an acceptance.
|
||||
The helper workflow uses Python 3.10+, Poppler tools and the PC's installed MiKTeX
|
||||
`pdflatex` compiler. The report can also be prepared without the skill
|
||||
by following `Report/AGENTS.md` directly.
|
||||
|
||||
Superseded templates, historical template-validation artifacts, maintenance
|
||||
scripts, and source-layout references are retained under `Report/unused/` and
|
||||
are not authoritative report inputs.
|
||||
+2
-2
@@ -41,7 +41,7 @@ When compiling LaTeX documents on Windows:
|
||||
|
||||
1. Before evaluating evidence, read the `Report Type` selector in `FAT_Checklist.xlsx`. If it unambiguously states FAT or Characterization, select the corresponding authoritative template without asking the user again. Ask only when the selector is missing, invalid, or conflicts with explicit user direction.
|
||||
2. Confirm that the six required report images are present in `../Media` with the exact basenames `I1` through `I6` and one supported extension: `.jpg`, `.jpeg`, `.png`, or `.pdf`.
|
||||
3. Confirm the exact stage, encoder, motor or actuator, drive, encoder interface, controller, firmware or revision where relevant, measurement system, calibration status, and test dates. If no exact stage model is available, omit or leave the model value blank; do not guess it and do not insert a placeholder.
|
||||
3. Confirm the exact stage identifier from the workbook, stage model, encoder, motor or actuator, drive, encoder interface, controller, firmware or revision where relevant, measurement system, calibration status, and test dates. Preserve leading zeros in the stage identifier. If no exact stage model or identifier is available, omit or leave the corresponding value blank; do not guess it and do not insert a placeholder.
|
||||
4. For a FAT, extract the applicable acceptance criteria before evaluating results. For characterization, describe the test scope and report measured results and relevant uncertainty without adding acceptance criteria or defined pass limits.
|
||||
5. Separate measured results, calculated values, manufacturer specifications, assumptions, and open points.
|
||||
6. Confirm which tests apply. Users complete the separate root `FAT_Checklist.xlsx` during the test. Do not mark checklist fields `N/A` unless the checklist explicitly offers that response; explain applicability in report narrative when needed.
|
||||
@@ -56,7 +56,7 @@ When compiling LaTeX documents on Windows:
|
||||
- Distinguish command resolution, encoder resolution, minimum incremental motion, repeatability, accuracy, stability, and measurement uncertainty.
|
||||
- State test direction, orientation, payload, travel, velocity, acceleration, settling criterion, cycle count, point count, sampling conditions, and environmental conditions when applicable.
|
||||
- Keep the five-column checklist format: `Item | Checklist Item | Yes | No | Remarks`.
|
||||
- The `Checklist` sheet in the root `FAT_Checklist.xlsx` must mirror the report's five checklist sections, item IDs, item wording, column names, and column order exactly. The workbook's separate `Read Me` sheet contains the report-type selector and editable project axis convention; those fields do not add or alter checklist rows.
|
||||
- The `Checklist` sheet in the root `FAT_Checklist.xlsx` must mirror the report's five checklist sections, item IDs, item wording, column names, and column order exactly. The workbook's separate `Read Me` sheet contains the report-type selector, stage identifier, and editable project axis convention; those fields do not add or alter checklist rows. Transfer the stage identifier as text so leading zeros are preserved.
|
||||
- Keep the report checklist blank in the baseline template. For a project-specific report, transfer the user's explicit Yes/No selections and remarks from the completed root `FAT_Checklist.xlsx` by matching the stable item IDs. Do not infer, change, or complete a blank spreadsheet response from other evidence. If both Yes and No are selected for one item, or the workbook is missing or ambiguous, leave that report item blank and record the issue for resolution.
|
||||
- Preserve the five-column table. A selected Yes or No may be rendered as a checkmark in only the selected response column; leave the other response column blank. Transfer remarks faithfully and retain any source references supplied by the user.
|
||||
- Size the `Checklist Item` column consistently to the longest checklist sentence; let `Remarks` fill the remaining width.
|
||||
|
||||
@@ -40,6 +40,7 @@
|
||||
|
||||
\newcommand{\TBD}{\textbf{TBD}}
|
||||
\newcommand{\StageModel}{\TBD}
|
||||
\newcommand{\StageIdentifier}{\TBD}
|
||||
\newcommand{\EncoderModel}{\TBD}
|
||||
\newcommand{\MotorModel}{\TBD}
|
||||
\newcommand{\DriveModel}{\TBD}
|
||||
@@ -126,14 +127,11 @@
|
||||
\fbox{\parbox[c][#1][c]{0.92\linewidth}{\centering Required image not found\\\path{#2.[jpg|jpeg|png|pdf]}}}}}}}}
|
||||
|
||||
% Keep the PSI identity with the report so the controlled cover does not depend
|
||||
% on a separate Template-Kivel checkout. The old path remains a compatibility
|
||||
% fallback for existing projects that have not yet copied the report asset.
|
||||
% on a separate source-template checkout.
|
||||
\newcommand{\PSILogo}{%
|
||||
\IfFileExists{assets/PSI_Logo.png}{%
|
||||
\includegraphics[width=32mm,height=11mm,keepaspectratio]{assets/PSI_Logo.png}}{%
|
||||
\IfFileExists{../Template-Kivel/Figures/PSI-Logo_narrow.pdf}{%
|
||||
\includegraphics[width=32mm,height=11mm,keepaspectratio]{../Template-Kivel/Figures/PSI-Logo_narrow.pdf}}{%
|
||||
\makebox(30,8)[l]{PSI}}}}
|
||||
\makebox(30,8)[l]{PSI}}}
|
||||
|
||||
\newlength{\checklistitemwidth}
|
||||
\settowidth{\checklistitemwidth}{\small Measurement system calibrated}
|
||||
@@ -210,6 +208,7 @@
|
||||
\begin{tabularx}{\linewidth}{|l|X|}
|
||||
\hline
|
||||
\textbf{Test type} & \TestType \\ \hline
|
||||
\textbf{Stage identifier} & \StageIdentifier \\ \hline
|
||||
\textbf{Encoder} & \EncoderModel \\ \hline
|
||||
\textbf{Motor} & \MotorModel \\ \hline
|
||||
\textbf{Drive} & \DriveModel \\ \hline
|
||||
@@ -351,6 +350,7 @@ Positive rotational direction & Right-hand rule \\ \hline
|
||||
\hline
|
||||
Component & Verified specification \\ \hline
|
||||
Stage & \StageModel \\
|
||||
Stage identifier & \StageIdentifier \\
|
||||
Travel & \TravelRange \\
|
||||
Encoder & \EncoderModel \\
|
||||
Encoder interface & \EncoderInterface \\
|
||||
|
||||
@@ -40,6 +40,7 @@
|
||||
|
||||
\newcommand{\TBD}{\textbf{TBD}}
|
||||
\newcommand{\StageModel}{\TBD}
|
||||
\newcommand{\StageIdentifier}{\TBD}
|
||||
\newcommand{\EncoderModel}{\TBD}
|
||||
\newcommand{\MotorModel}{\TBD}
|
||||
\newcommand{\DriveModel}{\TBD}
|
||||
@@ -133,14 +134,11 @@
|
||||
\fbox{\parbox[c][#1][c]{0.92\linewidth}{\centering Required image not found\\\path{#2.[jpg|jpeg|png|pdf]}}}}}}}}
|
||||
|
||||
% Keep the PSI identity with the report so the controlled cover does not depend
|
||||
% on a separate Template-Kivel checkout. The old path remains a compatibility
|
||||
% fallback for existing projects that have not yet copied the report asset.
|
||||
% on a separate source-template checkout.
|
||||
\newcommand{\PSILogo}{%
|
||||
\IfFileExists{assets/PSI_Logo.png}{%
|
||||
\includegraphics[width=32mm,height=11mm,keepaspectratio]{assets/PSI_Logo.png}}{%
|
||||
\IfFileExists{../Template-Kivel/Figures/PSI-Logo_narrow.pdf}{%
|
||||
\includegraphics[width=32mm,height=11mm,keepaspectratio]{../Template-Kivel/Figures/PSI-Logo_narrow.pdf}}{%
|
||||
\makebox(30,8)[l]{PSI}}}}
|
||||
\makebox(30,8)[l]{PSI}}}
|
||||
|
||||
\newlength{\checklistitemwidth}
|
||||
\settowidth{\checklistitemwidth}{\small Measurement system calibrated}
|
||||
@@ -217,6 +215,7 @@
|
||||
\begin{tabularx}{\linewidth}{|l|X|}
|
||||
\hline
|
||||
\textbf{Test type} & \TestType \\ \hline
|
||||
\textbf{Stage identifier} & \StageIdentifier \\ \hline
|
||||
\textbf{Encoder} & \EncoderModel \\ \hline
|
||||
\textbf{Motor} & \MotorModel \\ \hline
|
||||
\textbf{Drive} & \DriveModel \\ \hline
|
||||
@@ -358,6 +357,7 @@ Positive rotational direction & Right-hand rule \\ \hline
|
||||
\hline
|
||||
Component & Verified specification \\ \hline
|
||||
Stage & \StageModel \\
|
||||
Stage identifier & \StageIdentifier \\
|
||||
Travel & \TravelRange \\
|
||||
Encoder & \EncoderModel \\
|
||||
Encoder interface & \EncoderInterface \\
|
||||
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 41 KiB |
File renamed without changes.
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
Reference in new issue
Block a user