Skip to content

Commit a49ceba

Browse files
sbryngelsonclaude
andcommitted
viz: clarify which CLI options apply to which output modes
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 9491519 commit a49ceba

File tree

1 file changed

+27
-21
lines changed

1 file changed

+27
-21
lines changed

toolchain/mfc/cli/commands.py

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -927,15 +927,15 @@
927927
Argument(
928928
name="output",
929929
short="o",
930-
help="Directory for saved PNG images or MP4 video.",
930+
help="Output directory for --png and --mp4.",
931931
type=str,
932932
default=None,
933933
metavar="DIR",
934934
completion=Completion(type=CompletionType.DIRECTORIES),
935935
),
936936
Argument(
937937
name="cmap",
938-
help="Matplotlib colormap name.",
938+
help="Matplotlib colormap name (--interactive, --png, --mp4).",
939939
type=str,
940940
default='viridis',
941941
metavar="CMAP",
@@ -967,28 +967,28 @@
967967
),
968968
Argument(
969969
name="vmin",
970-
help="Minimum value for color scale.",
970+
help="Minimum value for color scale (--interactive, --png, --mp4).",
971971
type=float,
972972
default=None,
973973
metavar="VMIN",
974974
),
975975
Argument(
976976
name="vmax",
977-
help="Maximum value for color scale.",
977+
help="Maximum value for color scale (--interactive, --png, --mp4).",
978978
type=float,
979979
default=None,
980980
metavar="VMAX",
981981
),
982982
Argument(
983983
name="dpi",
984-
help="Image resolution in DPI.",
984+
help="Image resolution in DPI (--png, --mp4).",
985985
type=int,
986986
default=150,
987987
metavar="DPI",
988988
),
989989
Argument(
990990
name="slice-axis",
991-
help="Axis for 3D slice.",
991+
help="Axis for 3D slice (--interactive, --png, --mp4).",
992992
type=str,
993993
default='z',
994994
choices=["x", "y", "z"],
@@ -997,15 +997,15 @@
997997
),
998998
Argument(
999999
name="slice-value",
1000-
help="Coordinate value at which to take the 3D slice.",
1000+
help="Coordinate value at which to take the 3D slice (--interactive, --png, --mp4).",
10011001
type=float,
10021002
default=None,
10031003
dest="slice_value",
10041004
metavar="VAL",
10051005
),
10061006
Argument(
10071007
name="slice-index",
1008-
help="Array index at which to take the 3D slice.",
1008+
help="Array index at which to take the 3D slice (--interactive, --png, --mp4).",
10091009
type=int,
10101010
default=None,
10111011
dest="slice_index",
@@ -1019,7 +1019,7 @@
10191019
),
10201020
Argument(
10211021
name="fps",
1022-
help="Frames per second for MP4 output.",
1022+
help="Frames per second for --mp4 output.",
10231023
type=int,
10241024
default=10,
10251025
metavar="FPS",
@@ -1040,7 +1040,7 @@
10401040
),
10411041
Argument(
10421042
name="log-scale",
1043-
help="Use a logarithmic color/y scale (skips non-positive values).",
1043+
help="Logarithmic color/y scale (--interactive, --png, --mp4).",
10441044
action=ArgAction.STORE_TRUE,
10451045
default=False,
10461046
dest="log_scale",
@@ -1058,14 +1058,14 @@
10581058
),
10591059
Argument(
10601060
name="port",
1061-
help="Port for the interactive web server.",
1061+
help="Port for --interactive web server.",
10621062
type=int,
10631063
default=8050,
10641064
metavar="PORT",
10651065
),
10661066
Argument(
10671067
name="host",
1068-
help="Host/bind address for the interactive web server.",
1068+
help="Bind address for --interactive web server.",
10691069
default="127.0.0.1",
10701070
metavar="HOST",
10711071
),
@@ -1090,26 +1090,32 @@
10901090
Example("./mfc.sh viz case_dir/ --var pres --step 500 --slice-axis x --png", "3D: x-plane slice of pressure"),
10911091
],
10921092
key_options=[
1093-
("-- Discovery --", ""),
1093+
("-- Discovery (all modes) --", ""),
10941094
("--list-steps", "Print available timesteps and exit"),
10951095
("--list-vars", "Print available variable names and exit"),
1096-
("-- Variable / step selection --", ""),
1096+
("-- Data selection (all modes) --", ""),
10971097
("--var NAME", "Variable to plot (omit for tiled all-vars layout)"),
10981098
("--step STEP", "last (default), int, start:stop:stride, list, or 'all'"),
1099-
("-- Output modes --", ""),
1100-
("(default)", "Terminal UI — works over SSH, no browser needed (1D/2D)"),
1101-
("--interactive / -i", "Dash web UI in browser (supports 1D/2D/3D)"),
1102-
("--png", "Save PNG image(s) to case_dir/viz/; use -o DIR to change"),
1099+
("-f, --format", "Force binary or silo (auto-detected if omitted)"),
1100+
("-- Output mode --", ""),
1101+
("(default)", "Terminal UI (1D/2D, works over SSH, no browser needed)"),
1102+
("--interactive / -i", "Dash web UI (1D/2D/3D, needs browser or SSH tunnel)"),
1103+
("--png", "Save PNG image(s) to case_dir/viz/"),
11031104
("--mp4", "Encode frames into an MP4 video"),
1104-
("-- Appearance --", ""),
1105+
("-- Appearance (--interactive, --png, --mp4) --", ""),
11051106
("--cmap NAME", "Matplotlib colormap (default: viridis)"),
11061107
("--vmin / --vmax", "Fix color-scale limits"),
11071108
("--log-scale", "Logarithmic color/y axis"),
1108-
("--dpi N", "Image resolution (default: 150)"),
1109-
("-- 3D options --", ""),
1109+
("--dpi N", "Image resolution for --png/--mp4 (default: 150)"),
1110+
("-- 3D slicing (--interactive, --png, --mp4) --", ""),
11101111
("--slice-axis x|y|z", "Plane to slice (default: z midplane)"),
11111112
("--slice-value VAL", "Slice at coordinate value"),
11121113
("--slice-index IDX", "Slice at array index"),
1114+
("-- Mode-specific --", ""),
1115+
("-o, --output DIR", "Output directory for --png/--mp4 (default: case_dir/viz/)"),
1116+
("--fps N", "Frames per second for --mp4 (default: 10)"),
1117+
("--port PORT", "Web server port for --interactive (default: 8050)"),
1118+
("--host HOST", "Bind address for --interactive (default: 127.0.0.1)"),
11131119
],
11141120
)
11151121

0 commit comments

Comments
 (0)