-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
1831 lines (1743 loc) · 81.6 KB
/
index.html
File metadata and controls
1831 lines (1743 loc) · 81.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>PathFlow Guard Manual</title>
<meta
name="description"
content="Comprehensive illustrated operator and technical manual for PathFlow Guard."
>
<style>
:root {
--bg: #efe8db;
--deep: #10253d;
--deep-2: #0a1a2d;
--paper: rgba(255, 252, 247, 0.94);
--paper-strong: rgba(255, 255, 255, 0.98);
--line: rgba(22, 34, 55, 0.12);
--ink: #162237;
--muted: #576476;
--accent: #d66034;
--teal: #1f7560;
--gold: #af7625;
--danger: #a74235;
--shadow: 0 18px 60px rgba(18, 29, 45, 0.15);
--radius-xl: 28px;
--radius-lg: 22px;
--radius-md: 16px;
--sidebar-width: 320px;
--content-width: 1240px;
--sans: "Aptos", "Segoe UI", "Bahnschrift", sans-serif;
--mono: "Cascadia Code", "Consolas", monospace;
}
* { box-sizing: border-box; }
html { scroll-behavior: smooth; }
body {
margin: 0;
color: var(--ink);
font-family: var(--sans);
background:
radial-gradient(circle at top right, rgba(214, 96, 52, 0.12), transparent 22%),
radial-gradient(circle at 0% 100%, rgba(31, 117, 96, 0.12), transparent 28%),
linear-gradient(180deg, #f8f4ed 0%, var(--bg) 100%);
}
a { color: inherit; }
code, pre { font-family: var(--mono); }
img { display: block; max-width: 100%; }
.mobile-bar {
display: none;
position: sticky;
top: 0;
z-index: 80;
align-items: center;
justify-content: space-between;
gap: 12px;
padding: 14px 18px;
color: #edf5ff;
background: rgba(10, 26, 45, 0.94);
backdrop-filter: blur(16px);
border-bottom: 1px solid rgba(255, 255, 255, 0.08);
}
.mobile-bar button {
appearance: none;
border: 1px solid rgba(255, 255, 255, 0.18);
border-radius: 12px;
background: rgba(255, 255, 255, 0.08);
color: inherit;
padding: 9px 14px;
font: inherit;
cursor: pointer;
}
.layout {
display: grid;
grid-template-columns: minmax(284px, var(--sidebar-width)) minmax(0, 1fr);
min-height: 100vh;
}
.sidebar {
position: sticky;
top: 0;
align-self: start;
height: 100vh;
overflow: auto;
padding: 20px 18px 22px 22px;
color: #edf4ff;
background:
radial-gradient(circle at top left, rgba(255, 255, 255, 0.06), transparent 28%),
linear-gradient(180deg, rgba(16, 37, 61, 0.98), rgba(10, 26, 45, 0.98));
border-right: 1px solid rgba(255, 255, 255, 0.08);
}
.brand {
display: grid;
grid-template-columns: 52px minmax(0, 1fr);
gap: 14px;
align-items: center;
padding: 12px;
border-radius: 20px;
text-decoration: none;
border: 1px solid rgba(255, 255, 255, 0.1);
background: rgba(255, 255, 255, 0.04);
box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.08);
}
.brand svg { width: 52px; height: 52px; }
.brand strong {
display: block;
font-size: 1rem;
letter-spacing: 0.06em;
text-transform: uppercase;
}
.brand span {
display: block;
font-size: 0.84rem;
color: rgba(237, 244, 255, 0.7);
}
.sidebar h1 {
margin: 20px 0 10px;
font-size: 2rem;
line-height: 0.96;
letter-spacing: -0.03em;
}
.sidebar .intro {
margin: 0 0 18px;
color: rgba(237, 244, 255, 0.74);
line-height: 1.62;
font-size: 0.95rem;
}
.meta {
display: flex;
flex-wrap: wrap;
gap: 10px;
margin-bottom: 16px;
}
.pill {
display: inline-flex;
padding: 7px 12px;
border-radius: 999px;
font-size: 0.8rem;
text-transform: uppercase;
letter-spacing: 0.06em;
background: rgba(214, 96, 52, 0.16);
color: #ffd9c4;
}
.sidebar-card {
padding: 14px 14px 16px;
border-radius: 18px;
border: 1px solid rgba(255, 255, 255, 0.08);
background: rgba(255, 255, 255, 0.04);
margin-bottom: 18px;
}
.sidebar-card strong { display: block; margin-bottom: 8px; }
.sidebar-card p,
.sidebar-card ul {
margin: 0;
color: rgba(237, 244, 255, 0.74);
line-height: 1.55;
font-size: 0.9rem;
}
.sidebar-card ul { padding-left: 18px; }
.sidebar-nav a {
display: block;
padding: 10px 12px;
margin: 2px 0;
text-decoration: none;
border-left: 3px solid transparent;
border-radius: 0 14px 14px 0;
color: rgba(237, 244, 255, 0.74);
transition: 140ms ease;
}
.sidebar-nav a:hover,
.sidebar-nav a.active {
color: #ffffff;
background: rgba(255, 255, 255, 0.08);
border-left-color: var(--accent);
transform: translateX(2px);
}
.sidebar-links {
display: grid;
gap: 8px;
margin-top: 18px;
}
.sidebar-links a {
color: rgba(237, 244, 255, 0.74);
font-size: 0.9rem;
text-decoration: none;
}
.content { padding: 28px; }
.content-inner {
max-width: var(--content-width);
margin: 0 auto;
display: grid;
gap: 22px;
}
.panel,
.hero {
position: relative;
overflow: hidden;
border-radius: var(--radius-xl);
border: 1px solid var(--line);
background: var(--paper);
box-shadow: var(--shadow);
backdrop-filter: blur(18px);
}
.panel { padding: 28px; }
.hero {
padding: 34px;
display: grid;
grid-template-columns: minmax(0, 1.08fr) minmax(360px, 0.92fr);
gap: 24px;
align-items: start;
}
.hero::before,
.panel::before {
content: "";
position: absolute;
inset: 0;
pointer-events: none;
background:
radial-gradient(circle at top right, rgba(214, 96, 52, 0.08), transparent 24%),
linear-gradient(180deg, rgba(255, 255, 255, 0.18), rgba(255, 255, 255, 0));
}
.eyebrow {
margin: 0 0 10px;
font-size: 0.82rem;
font-weight: 700;
letter-spacing: 0.18em;
text-transform: uppercase;
color: var(--accent);
}
h2 {
margin: 0 0 12px;
line-height: 0.98;
letter-spacing: -0.045em;
font-size: clamp(2rem, 3vw, 3.3rem);
}
h3 { margin: 0 0 10px; font-size: 1.08rem; }
p {
margin: 0;
color: var(--muted);
line-height: 1.7;
}
p + p { margin-top: 10px; }
.lede { max-width: 66ch; font-size: 1.04rem; }
.tag-row,
.chapter-links,
.decision-row {
display: flex;
flex-wrap: wrap;
gap: 10px;
margin-top: 18px;
}
.tag,
.chapter-links a {
display: inline-flex;
padding: 8px 12px;
border-radius: 999px;
background: rgba(16, 37, 61, 0.08);
border: 1px solid rgba(16, 37, 61, 0.1);
color: var(--ink);
text-decoration: none;
font-size: 0.88rem;
}
.hero-stats,
.card-grid,
.steps,
.callout-grid,
.split-grid,
.matrix-grid,
.table-card-grid,
.mini-grid {
display: grid;
gap: 16px;
}
.hero-stats { grid-template-columns: repeat(2, minmax(0, 1fr)); margin-top: 18px; }
.card-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); }
.steps { grid-template-columns: repeat(4, minmax(0, 1fr)); }
.callout-grid,
.split-grid { grid-template-columns: repeat(2, minmax(0, 1fr)); }
.matrix-grid { grid-template-columns: 1.1fr 0.9fr; }
.table-card-grid { grid-template-columns: 1.2fr 0.8fr; }
.mini-grid { grid-template-columns: repeat(4, minmax(0, 1fr)); }
.stat,
.card,
.step,
.callout,
.guide,
.mini-card {
position: relative;
z-index: 1;
padding: 18px;
border-radius: var(--radius-lg);
border: 1px solid var(--line);
background: var(--paper-strong);
}
.stat strong,
.mini-card strong {
display: block;
margin-bottom: 6px;
font-size: 1.6rem;
line-height: 1;
letter-spacing: -0.05em;
color: var(--ink);
}
.kicker {
display: inline-block;
margin-bottom: 10px;
padding: 6px 10px;
border-radius: 999px;
font-size: 0.76rem;
letter-spacing: 0.08em;
text-transform: uppercase;
background: rgba(214, 96, 52, 0.1);
color: var(--accent);
}
.section-header {
display: flex;
align-items: end;
justify-content: space-between;
gap: 18px;
margin-bottom: 18px;
}
.section-header .small { max-width: 54ch; font-size: 0.94rem; }
.figure,
.asset-figure {
position: relative;
z-index: 1;
border-radius: var(--radius-xl);
border: 1px solid var(--line);
background:
linear-gradient(180deg, rgba(255, 255, 255, 0.95), rgba(248, 243, 234, 0.95));
padding: 20px;
box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.78);
}
.figure svg { width: 100%; height: auto; display: block; }
.asset-figure { padding: 0; overflow: hidden; }
.asset-figure figcaption,
.figure figcaption {
margin-top: 12px;
color: var(--muted);
font-size: 0.94rem;
line-height: 1.62;
}
.asset-figure figcaption { padding: 14px 18px 18px; margin-top: 0; }
.note,
.warning {
position: relative;
z-index: 1;
padding: 15px 18px;
border-radius: var(--radius-md);
line-height: 1.65;
}
.note {
background: rgba(31, 117, 96, 0.08);
border: 1px solid rgba(31, 117, 96, 0.18);
color: #205c4c;
}
.warning {
background: rgba(214, 96, 52, 0.08);
border: 1px solid rgba(214, 96, 52, 0.16);
color: #8c3619;
}
.decision {
display: inline-flex;
padding: 8px 12px;
border-radius: 999px;
font-size: 0.88rem;
text-transform: uppercase;
letter-spacing: 0.05em;
border: 1px solid transparent;
}
.decision.accept {
background: rgba(31, 117, 96, 0.12);
border-color: rgba(31, 117, 96, 0.2);
color: var(--teal);
}
.decision.review {
background: rgba(175, 118, 37, 0.12);
border-color: rgba(175, 118, 37, 0.22);
color: var(--gold);
}
.decision.reject {
background: rgba(167, 66, 53, 0.1);
border-color: rgba(167, 66, 53, 0.18);
color: var(--danger);
}
.code-block {
position: relative;
z-index: 1;
overflow-x: auto;
padding: 18px;
border-radius: var(--radius-lg);
background: #0e192a;
border: 1px solid rgba(255, 255, 255, 0.06);
color: #eef4ff;
box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.05);
}
.code-block code {
white-space: pre;
font-size: 0.92rem;
line-height: 1.68;
}
.table-wrap {
position: relative;
z-index: 1;
overflow-x: auto;
border: 1px solid var(--line);
border-radius: var(--radius-lg);
background: var(--paper-strong);
}
table {
width: 100%;
min-width: 720px;
border-collapse: collapse;
}
th,
td {
padding: 14px 16px;
text-align: left;
vertical-align: top;
border-bottom: 1px solid var(--line);
line-height: 1.58;
color: var(--muted);
}
th {
background: rgba(16, 37, 61, 0.05);
color: var(--ink);
font-size: 0.84rem;
text-transform: uppercase;
letter-spacing: 0.06em;
}
td strong { color: var(--ink); }
tr:last-child td { border-bottom: none; }
ul, ol {
margin: 0;
padding-left: 20px;
color: var(--muted);
}
li + li { margin-top: 8px; }
.footer {
padding: 8px 10px 26px;
color: var(--muted);
text-align: center;
font-size: 0.92rem;
}
@media (max-width: 1180px) {
.hero,
.matrix-grid,
.table-card-grid,
.split-grid,
.callout-grid,
.card-grid { grid-template-columns: 1fr; }
.mini-grid { grid-template-columns: repeat(2, minmax(0, 1fr)); }
.steps { grid-template-columns: repeat(2, minmax(0, 1fr)); }
}
@media (max-width: 900px) {
.layout { grid-template-columns: 1fr; }
.mobile-bar { display: flex; }
.sidebar {
position: fixed;
inset: 0 auto 0 0;
z-index: 90;
width: min(88vw, 340px);
transform: translateX(-100%);
transition: transform 180ms ease;
}
body.sidebar-open .sidebar { transform: translateX(0); }
.content { padding: 0 18px 22px; }
.content-inner { padding-top: 18px; }
}
@media (max-width: 720px) {
.hero,
.panel { padding: 22px; }
.hero,
.hero-stats,
.mini-grid,
.steps { grid-template-columns: 1fr; }
.section-header { display: block; }
.section-header .small { margin-top: 10px; }
}
</style>
</head>
<body>
<div class="mobile-bar">
<strong>PathFlow Guard Manual</strong>
<button type="button" data-sidebar-toggle>Sections</button>
</div>
<div class="layout">
<aside class="sidebar" id="sidebar">
<a class="brand" href="https://www.gregorigin.com" target="_blank" rel="noreferrer">
<svg viewBox="0 0 88 88" aria-hidden="true">
<defs>
<linearGradient id="brandGradient" x1="0%" y1="0%" x2="100%" y2="100%">
<stop offset="0%" stop-color="#ffb179"></stop>
<stop offset="100%" stop-color="#d66034"></stop>
</linearGradient>
</defs>
<rect x="5" y="5" width="78" height="78" rx="24" fill="#ffffff" opacity="0.08"></rect>
<path d="M27 25h18c8.5 0 15 6.1 15 15 0 9-6.5 15-15 15H35v11H27V25zm8 8v14h10c4.4 0 7-2.8 7-7s-2.6-7-7-7H35z" fill="url(#brandGradient)"></path>
<path d="M47 61c0-9.3 7.1-16.3 16.6-16.3 4.5 0 8.5 1.3 11.4 3.7l-4.7 5.7c-1.7-1.4-3.9-2.2-6.5-2.2-5.1 0-8.9 3.8-8.9 9.1 0 5.4 3.6 9.2 9.4 9.2 1.6 0 3-.2 4.1-.8v-4.3H63v-6.7h13.2v15.7c-3.9 2.8-8.1 4-13.1 4C54.1 77.8 47 70.8 47 61z" fill="#ffffff"></path>
</svg>
<div>
<strong>GregOrigin</strong>
<span>Illustrated product manual</span>
</div>
</a>
<h1>PathFlow Guard</h1>
<p class="intro">
Edge-first pathology QC, deterministic intake policy, auditable routing, and deployable
Windows packaging in one repository. This page is the operator guide, system map, and
technical reference.
</p>
<div class="meta">
<span class="pill">Python runtime</span>
<span class="pill">C++ + Rust companions</span>
<span class="pill">SVS aware</span>
</div>
<div class="sidebar-card">
<strong>What this manual covers</strong>
<ul>
<li>How to run PathFlow Guard from source or packaged EXE</li>
<li>How requests are resolved, evaluated, persisted, and routed</li>
<li>How raster tiles and whole-slide sampling work</li>
<li>How operators inspect jobs, manifests, and audit records</li>
</ul>
</div>
<nav class="sidebar-nav" aria-label="Section navigation">
<a href="#overview">Overview</a>
<a href="#quickstart">Quick Start</a>
<a href="#workflow">Workflow</a>
<a href="#requests">Request Model</a>
<a href="#decisions">Decision Engine</a>
<a href="#imaging">Imaging</a>
<a href="#interfaces">Interfaces</a>
<a href="#workspace">Workspace</a>
<a href="#build">Build + Deploy</a>
<a href="#quality">Verification + Quality</a>
<a href="#troubleshooting">Troubleshooting</a>
<a href="#reference">Reference</a>
</nav>
<div class="sidebar-links">
<a href="../../README.md">README.md</a>
<a href="../architecture.md">Architecture notes</a>
<a href="../research.md">Research basis</a>
<a href="../quality/software-lifecycle.md">Software lifecycle</a>
<a href="../quality/traceability-matrix.md">Traceability matrix</a>
</div>
</aside>
<main class="content">
<div class="content-inner">
<section class="hero" id="overview">
<div>
<p class="eyebrow">Operator And Technical Manual</p>
<h2>Catch low-quality slide packages before they become downstream cost, noise, or risk.</h2>
<p class="lede">
PathFlow Guard is a workflow-support application for digital pathology intake. It
evaluates slide packages before cloud upload, extracts quality metrics from raster
tiles or OpenSlide-backed whole-slide images, assigns an <code>accept</code>,
<code>review</code>, or <code>reject</code> outcome, writes deterministic manifests,
and stores an audit trail that can be re-read later.
</p>
<p class="lede">
The shipping workflow today is Python-centered. The repository also includes a C++
QC core, a Rust integrity attestor, an Azure deployment skeleton, CI/CD, and
regulated-development documentation.
</p>
<div class="tag-row">
<span class="tag">CLI + Dashboard + JSON API</span>
<span class="tag">SQLite job history</span>
<span class="tag">OpenSlide runtime discovery</span>
<span class="tag">PyInstaller Windows EXE</span>
<span class="tag">Deterministic BLAKE2b manifests</span>
</div>
<div class="hero-stats">
<article class="stat">
<strong>3</strong>
<p>routing lanes: accept, review, reject</p>
</article>
<article class="stat">
<strong>7</strong>
<p>top-level workspace outputs created during normal operation</p>
</article>
<article class="stat">
<strong>2</strong>
<p>request modes: direct metrics input or package-driven extraction</p>
</article>
<article class="stat">
<strong>1</strong>
<p>inspectable story: request, decision, manifest, audit, stored package</p>
</article>
</div>
<div class="chapter-links">
<a href="#quickstart">Run It</a>
<a href="#workflow">See The Flow</a>
<a href="#workspace">Inspect Artifacts</a>
<a href="#troubleshooting">Fix Common Problems</a>
</div>
</div>
<figure class="figure">
<h3>System overview</h3>
<svg viewBox="0 0 760 520" role="img" aria-label="Overview of scanner to PathFlow Guard to routed outcomes">
<defs>
<linearGradient id="heroA" x1="0%" y1="0%" x2="100%" y2="100%">
<stop offset="0%" stop-color="#17324c"></stop>
<stop offset="100%" stop-color="#10253d"></stop>
</linearGradient>
</defs>
<rect x="20" y="20" width="720" height="480" rx="34" fill="#faf7f2"></rect>
<rect x="56" y="68" width="184" height="132" rx="24" fill="url(#heroA)"></rect>
<rect x="80" y="92" width="132" height="16" rx="8" fill="#e9f3ff" opacity="0.95"></rect>
<rect x="80" y="122" width="88" height="54" rx="12" fill="#d66034"></rect>
<rect x="176" y="122" width="36" height="54" rx="12" fill="#ffb179"></rect>
<text x="82" y="188" fill="#edf4ff" font-size="15" font-family="Segoe UI, sans-serif">scanner export or package folder</text>
<path d="M242 134h72" stroke="#d66034" stroke-width="8" stroke-linecap="round"></path>
<polygon points="314,134 296,123 296,145" fill="#d66034"></polygon>
<rect x="326" y="64" width="172" height="144" rx="24" fill="#fffdf8" stroke="#e5ddd2" stroke-width="2"></rect>
<rect x="352" y="150" width="120" height="32" rx="14" fill="#eef6f3" stroke="#d2e5de"></rect>
<text x="366" y="171" fill="#1f7560" font-size="15" font-family="Segoe UI, sans-serif" font-weight="700">extract metrics if needed</text>
<text x="360" y="196" fill="#5c6673" font-size="14" font-family="Segoe UI, sans-serif">focus, tissue, artifacts, bytes</text>
<path d="M498 134h72" stroke="#d66034" stroke-width="8" stroke-linecap="round"></path>
<polygon points="570,134 552,123 552,145" fill="#d66034"></polygon>
<rect x="582" y="52" width="118" height="168" rx="24" fill="#fff7f2" stroke="#efd4c6" stroke-width="2"></rect>
<text x="608" y="86" fill="#8c3619" font-size="20" font-family="Segoe UI, sans-serif" font-weight="700">policy</text>
<text x="604" y="114" fill="#6b5a50" font-size="14" font-family="Segoe UI, sans-serif">objective power</text>
<text x="604" y="138" fill="#6b5a50" font-size="14" font-family="Segoe UI, sans-serif">file size</text>
<text x="604" y="162" fill="#6b5a50" font-size="14" font-family="Segoe UI, sans-serif">focus thresholds</text>
<text x="604" y="186" fill="#6b5a50" font-size="14" font-family="Segoe UI, sans-serif">tissue thresholds</text>
<text x="604" y="210" fill="#6b5a50" font-size="14" font-family="Segoe UI, sans-serif">artifact thresholds</text>
<path d="M142 224v66" stroke="#17324c" stroke-width="8" stroke-linecap="round"></path>
<path d="M412 232v58" stroke="#17324c" stroke-width="8" stroke-linecap="round"></path>
<path d="M640 244v46" stroke="#17324c" stroke-width="8" stroke-linecap="round"></path>
<rect x="58" y="304" width="170" height="86" rx="24" fill="#eef6f3" stroke="#d0e6de" stroke-width="2"></rect>
<text x="104" y="345" fill="#1f7560" font-size="28" font-family="Segoe UI, sans-serif" font-weight="700">ACCEPT</text>
<rect x="326" y="304" width="172" height="86" rx="24" fill="#fff8eb" stroke="#efdcb2" stroke-width="2"></rect>
<text x="376" y="345" fill="#af7625" font-size="28" font-family="Segoe UI, sans-serif" font-weight="700">REVIEW</text>
<rect x="554" y="304" width="172" height="86" rx="24" fill="#fff0ed" stroke="#edcbc6" stroke-width="2"></rect>
<text x="610" y="345" fill="#a74235" font-size="28" font-family="Segoe UI, sans-serif" font-weight="700">REJECT</text>
<rect x="92" y="420" width="560" height="46" rx="18" fill="url(#heroA)"></rect>
<text x="118" y="449" fill="#edf4ff" font-size="16" font-family="Segoe UI, sans-serif">every job also writes request JSON, manifest JSON, audit JSON, and SQLite rows</text>
</svg>
<figcaption>
PathFlow Guard is deliberately linear. A request is resolved, metrics are extracted
if missing, policy is applied, and outputs are written in a form that operators can
inspect directly on disk or through the API.
</figcaption>
</figure>
</section>
<section class="panel" id="quickstart">
<div class="section-header">
<div>
<p class="eyebrow">Quick Start</p>
<h2>Two practical ways to run the product.</h2>
</div>
<p class="small">
Use the source path while developing or validating changes. Use the packaged
executable when you want the operator-facing Windows delivery.
</p>
</div>
<div class="callout-grid">
<article class="callout">
<span class="kicker">Prerequisites</span>
<h3>Minimum runtime expectations</h3>
<ul>
<li>Python 3.12 or newer for the source-installed orchestrator</li>
<li>Windows 11 or another environment supported by your Python and OpenSlide toolchain</li>
<li>OpenSlide native runtime for real whole-slide extraction outside the packaged Windows flow</li>
</ul>
</article>
<article class="callout">
<span class="kicker">First validation</span>
<h3>Three commands worth learning first</h3>
<ul>
<li><code>pathflow-guard doctor</code> reports runtime capabilities</li>
<li><code>pathflow-guard demo</code> seeds sample jobs into a workspace</li>
<li><code>pathflow-guard serve</code> starts the local dashboard and API</li>
</ul>
</article>
</div>
<div class="table-card-grid">
<div class="code-block">
<code>cd python\orchestrator
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"
pathflow-guard doctor
pathflow-guard init --workspace .\runtime
pathflow-guard demo --workspace .\runtime
pathflow-guard report --workspace .\runtime
pathflow-guard serve --workspace .\runtime --port 8765</code>
</div>
<article class="guide">
<h3>Run from source</h3>
<p>
This is the normal developer path. If your Python Scripts directory is not on
<code>PATH</code>, use the module form:
<code>python -m pathflow_guard.cli doctor</code>.
</p>
</article>
</div>
<div class="table-card-grid">
<div class="code-block">
<code>cd python\orchestrator
.\build_windows.ps1
.\dist\PathFlowGuard.exe doctor
.\dist\PathFlowGuard.exe init --workspace .\runtime
.\dist\PathFlowGuard.exe demo --workspace .\runtime
.\dist\PathFlowGuard.exe serve --workspace .\runtime --port 8765</code>
</div>
<article class="guide">
<h3>Run the packaged EXE</h3>
<p>
The build script installs dependencies, runs PyInstaller with
<code>PathFlowGuard.spec</code>, and produces <code>dist\PathFlowGuard.exe</code>.
Add <code>-SmokeTest</code> when you want a packaged-workflow validation.
</p>
</article>
</div>
<div class="note">
Preferred operator sequence: run <code>doctor</code>, initialize a workspace, seed
demo data or ingest a real request, then open the dashboard at
<code>http://127.0.0.1:8765</code>.
</div>
</section>
<section class="panel" id="workflow">
<div class="section-header">
<div>
<p class="eyebrow">Workflow</p>
<h2>The runtime is a stepwise evidence pipeline.</h2>
</div>
<p class="small">
The workflow is intentionally small and inspectable. Each step either adds evidence
to the request or records an output that can be revisited later.
</p>
</div>
<div class="steps">
<article class="step">
<span class="kicker">1</span>
<h3>Read request</h3>
<p>Load a JSON payload into the strict request model and validate required string fields.</p>
</article>
<article class="step">
<span class="kicker">2</span>
<h3>Resolve context</h3>
<p>Resolve <code>package_path</code> relative to the request file and compute file bytes when absent.</p>
</article>
<article class="step">
<span class="kicker">3</span>
<h3>Extract metrics</h3>
<p>If focus, tissue, or artifact fields are missing, PathFlow Guard samples the package.</p>
</article>
<article class="step">
<span class="kicker">4</span>
<h3>Evaluate policy</h3>
<p>Threshold and compatibility checks generate reason codes and a deterministic routing decision.</p>
</article>
<article class="step">
<span class="kicker">5</span>
<h3>Persist artifacts</h3>
<p>Write the resolved request JSON, optional manifest, audit JSON, and SQLite rows.</p>
</article>
<article class="step">
<span class="kicker">6</span>
<h3>Route payload</h3>
<p>Copy the package into <code>accepted/</code>, <code>review/</code>, or <code>rejected/</code>.</p>
</article>
<article class="step">
<span class="kicker">7</span>
<h3>Expose results</h3>
<p>The same job can be viewed on disk, in SQLite, on the dashboard, or through the JSON API.</p>
</article>
<article class="step">
<span class="kicker">8</span>
<h3>Escalate uncertainty</h3>
<p>Borderline conditions are routed to manual review instead of being silently accepted.</p>
</article>
</div>
<div class="matrix-grid">
<figure class="figure">
<h3>Lifecycle of one request</h3>
<svg viewBox="0 0 820 420" role="img" aria-label="Lifecycle of one request from JSON through artifacts">
<rect x="20" y="20" width="780" height="380" rx="34" fill="#faf7f2"></rect>
<rect x="50" y="84" width="138" height="88" rx="20" fill="#17324c"></rect>
<text x="86" y="124" fill="#edf4ff" font-size="22" font-family="Segoe UI, sans-serif" font-weight="700">request</text>
<text x="79" y="148" fill="#edf4ff" font-size="14" font-family="Segoe UI, sans-serif">accept.json</text>
<rect x="246" y="84" width="154" height="88" rx="20" fill="#fffdf8" stroke="#dfd6ca"></rect>
<text x="279" y="120" fill="#162237" font-size="18" font-family="Segoe UI, sans-serif" font-weight="700">resolve context</text>
<text x="270" y="146" fill="#5f6b7a" font-size="14" font-family="Segoe UI, sans-serif">absolute path, bytes, metrics</text>
<rect x="456" y="84" width="144" height="88" rx="20" fill="#fff7f2" stroke="#efd2c3"></rect>
<text x="493" y="120" fill="#8c3619" font-size="18" font-family="Segoe UI, sans-serif" font-weight="700">evaluate</text>
<text x="486" y="146" fill="#6d594f" font-size="14" font-family="Segoe UI, sans-serif">reasons + decision</text>
<rect x="640" y="84" width="120" height="88" rx="20" fill="#eef6f3" stroke="#d0e6de"></rect>
<text x="664" y="120" fill="#1f7560" font-size="18" font-family="Segoe UI, sans-serif" font-weight="700">persist</text>
<text x="656" y="146" fill="#546962" font-size="14" font-family="Segoe UI, sans-serif">job record</text>
<path d="M188 128h58M400 128h56M600 128h40" stroke="#162237" stroke-width="7" stroke-linecap="round"></path>
<polygon points="246,128 230,118 230,138" fill="#162237"></polygon>
<polygon points="456,128 440,118 440,138" fill="#162237"></polygon>
<polygon points="640,128 624,118 624,138" fill="#162237"></polygon>
<rect x="68" y="244" width="178" height="110" rx="22" fill="#fffdf8" stroke="#dfd6ca"></rect>
<text x="100" y="280" fill="#162237" font-size="18" font-family="Segoe UI, sans-serif" font-weight="700">request record</text>
<text x="94" y="306" fill="#5f6b7a" font-size="14" font-family="Segoe UI, sans-serif">runtime\requests\job-....json</text>
<rect x="292" y="244" width="178" height="110" rx="22" fill="#fffdf8" stroke="#dfd6ca"></rect>
<text x="330" y="280" fill="#162237" font-size="18" font-family="Segoe UI, sans-serif" font-weight="700">manifest</text>
<text x="316" y="306" fill="#5f6b7a" font-size="14" font-family="Segoe UI, sans-serif">runtime\manifests\job-....json</text>
<rect x="516" y="244" width="240" height="110" rx="22" fill="#fffdf8" stroke="#dfd6ca"></rect>
<text x="566" y="280" fill="#162237" font-size="18" font-family="Segoe UI, sans-serif" font-weight="700">audit + route</text>
<text x="542" y="306" fill="#5f6b7a" font-size="14" font-family="Segoe UI, sans-serif">audit JSON, SQLite rows, copied package</text>
<path d="M700 172v48M700 220h-542" stroke="#d66034" stroke-width="6" stroke-linecap="round"></path>
<polygon points="158,220 174,210 174,230" fill="#d66034"></polygon>
</svg>
<figcaption>
The runtime is designed so one job can always be explained after the fact. The
resolved request, decision, copied payload, and audit trail remain linked by job ID.
</figcaption>
</figure>
<article class="guide">
<h3>Operator expectations</h3>
<ul>
<li>Use JSON requests for repeatable intake and evidence preservation.</li>
<li>Prefer <code>ingest</code> when you want an auditable job, not just a dry evaluation.</li>
<li>Use <code>report</code> for a quick workspace summary and recent job list.</li>
<li>Use <code>/jobs/<job_id></code> when reviewing one routed case in the browser.</li>
</ul>
<div class="decision-row">
<span class="decision accept">accept -> upload lane</span>
<span class="decision review">review -> manual hold</span>
<span class="decision reject">reject -> rescan path</span>
</div>
</article>
</div>
</section>
<section class="panel" id="requests">
<div class="section-header">
<div>
<p class="eyebrow">Request Model</p>
<h2>Requests are simple by design, but the runtime enriches them before evaluation.</h2>
</div>
<p class="small">
PathFlow Guard accepts direct metric input, package-driven extraction, or a mix of
both. Missing bytes and QC metrics can be resolved automatically when a package path
is present.
</p>
</div>
<div class="split-grid">
<div class="code-block">
<code>{
"case_id": "CASE-2026-101",
"slide_id": "SLIDE-101",
"site_id": "SITE-EDGE-ALPHA",
"objective_power": 40,
"file_bytes": 0,
"package_path": "../packages/accept-package",
"notes": "Expected accept lane sample."
}</code>
</div>
<article class="guide">
<h3>What happens to this sample</h3>
<p>
The sample request does not provide focus, tissue, or artifact metrics, so the
pipeline resolves the package path, measures bytes from disk, extracts the missing
metrics, and only then applies the rule engine.
</p>
</article>
</div>
<div class="table-wrap">
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Required</th>
<th>Meaning</th>
<th>Runtime behavior</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>case_id</strong></td>
<td>string</td>
<td>yes</td>
<td>Case identifier carried into job records and UI views</td>
<td>Empty values fail validation</td>
</tr>
<tr>
<td><strong>slide_id</strong></td>
<td>string</td>
<td>yes</td>
<td>Slide identifier used in audit and review screens</td>
<td>Empty values fail validation</td>
</tr>
<tr>
<td><strong>site_id</strong></td>
<td>string</td>
<td>yes</td>
<td>Edge location or originating site</td>
<td>Empty values fail validation</td>
</tr>
<tr>
<td><strong>objective_power</strong></td>
<td>integer</td>
<td>no</td>
<td>Scanner objective power</td>
<td>Defaults to 40; unsupported values cause review</td>
</tr>
<tr>
<td><strong>file_bytes</strong></td>
<td>integer</td>
<td>no</td>
<td>Declared package size</td>
<td>If zero and a package exists, the pipeline measures bytes from disk</td>
</tr>
<tr>
<td><strong>focus_score</strong></td>
<td>float</td>
<td>conditional</td>
<td>Sharpness-derived score</td>
<td>Must be present or extractable from image data</td>
</tr>
<tr>
<td><strong>tissue_coverage</strong></td>
<td>float</td>
<td>conditional</td>
<td>Fraction of tile pixels treated as tissue-bearing</td>
<td>Must be present or extractable from image data</td>
</tr>
<tr>
<td><strong>artifact_ratio</strong></td>
<td>float</td>
<td>conditional</td>
<td>Fraction of pixels flagged as likely artifact</td>
<td>Must be present or extractable from image data</td>
</tr>
<tr>
<td><strong>package_path</strong></td>
<td>string</td>
<td>no</td>
<td>File or directory containing tiles or a whole-slide image</td>
<td>Relative paths are resolved from the request JSON location</td>
</tr>
<tr>
<td><strong>notes</strong></td>
<td>string</td>
<td>no</td>
<td>Operator note persisted into the stored request and SQLite row</td>
<td>Defaults to empty string</td>
</tr>
</tbody>
</table>
</div>
<div class="callout-grid">
<article class="callout">
<span class="kicker">Resolution rules</span>
<h3>When the runtime changes the request</h3>
<ul>
<li>Relative <code>package_path</code> values become absolute paths before use.</li>
<li><code>file_bytes</code> is computed from disk if the declared value is not usable.</li>
<li>Missing QC metrics trigger automatic extraction from the slide package.</li>
<li>The resolved request is what gets written to <code>requests/</code>.</li>
</ul>