You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Installs postprocess-specific dependencies such as the graphics dashboard (optional)
40
-
pip install -e ".[postprocess]"
41
38
```
42
39
43
40
### 2. Development Setup (Contributor)
44
41
45
42
```sh
46
43
# Install all dependencies including dev tools (ruff, pre-commit, pyinstaller)
47
-
pip install -e ".[dev,pipelines,postprocess]"
44
+
pip install -e ".[dev,pipelines]"
48
45
49
46
# Initialize pre-commit hooks (optionnal)
50
47
pre-commit install
@@ -76,10 +73,7 @@ Launch the main application to process files interactively:
76
73
77
74
The GUI handles batch processing for folders, single .h5/.hdf5 files, or .zip archives and lets you run multiple pipelines at once. Batch outputs preserve the input subfolder layout under the chosen output directory (one combined `.h5` per input file).
78
75
79
-
You can also selectbatch-level postprocess steps. These run after the selected pipelines finish and before optional zipping, so any generated dashboards, PNGs, or summaries are included in the final output folder or archive.
80
-
81
76
Use the Pipeline Library tab to selectwhich pipelines run. Selection preferences are saved per user between app launches, including installed builds.
82
-
Use the Postprocess Library tab the same way for postprocess steps.
83
77
84
78
```sh
85
79
# Via the entry point
@@ -91,7 +85,7 @@ python src/eye_flow.py
91
85
92
86
When you run `eyeflow` from inside the repository checkout, the launcher prefers the local`src/` tree so newly added or edited pipelines are picked up without needing a full reinstall.
93
87
94
-
Installed builds expose editable `pipelines/`and `postprocess/` folders next to `EyeFlow.exe`; use the Library tabs' Open folder and Reload buttons to edit and refresh them.
88
+
Installed builds expose an editable `pipelines/`folder next to `EyeFlow.exe`; use the Pipeline Library tab's Open folder and Reload buttons to edit and refresh it.
95
89
96
90
### CLI
97
91
@@ -145,54 +139,3 @@ class MyAnalysis(ProcessPipeline):
145
139
attrs=attrs
146
140
)
147
141
```
148
-
149
-
## Postprocess System
150
-
151
-
Postprocess steps are discovered from `src/postprocess/` in the same spirit as pipelines, but they run once per batch over the generated pipeline output folder.
152
-
153
-
Use `@registerPostprocess(...)` to declare:
154
-
155
-
- optional Python package dependencies with `required_deps`
156
-
- required pipeline outputs with `required_pipelines`
157
-
158
-
### Simple Postprocess Structure
159
-
160
-
```python
161
-
from postprocess.core.base import (
162
-
BatchPostprocess,
163
-
PostprocessContext,
164
-
PostprocessResult,
165
-
registerPostprocess,
166
-
)
167
-
168
-
169
-
@registerPostprocess(
170
-
name="My Batch Summary",
171
-
description="Aggregate metrics across the generated batch outputs.",
- write extra artifacts into `context.output_dir` before optional zipping
194
-
- return a short `summary`, explicit `generated_paths`, and structured `metadata`
195
-
196
-
The included `Graphics Dashboard` postprocess shows the intended pattern: it consumes the `arterial_waveform_shape_metrics` output and generates a cohort dashboard plus PNG exports after the batch finishes.
197
-
`Pipeline Metrics Manifest` is a lighter built-in example that writes a JSON inventory of the generated pipeline metric datasets for the batch.
198
-
`Postprocess Tutorial` is the minimal reference example: it writes a single JSON file showing every `PostprocessContext` field and the `PostprocessResult` output format.
0 commit comments