Redesign config validation

configs/config_camus.yaml

@@ -1,29 +1,12 @@
 # config_camus.yaml - comments were autogenerated from PARAMETER_DESCRIPTIONS in zea/config/parameters.py
-# The data section contains the parameters for the data.
+# Data path and loading settings.
 data:
-  # The path of the folder to load data files from (relative to the user data
-  # root as set in users.yaml)
-  dataset_folder: hf://zeahub/camus-sample
-  # The path of the file to load when running the UI (either an absolute path or
-  # one relative to the dataset folder)
-  file_path: val/patient0401/patient0401_4CH_half_sequence.hdf5
+  # Full path to the data file. Supports absolute paths, paths relative to the
+  # user data root (set in users.yaml), and Hugging Face Hub paths
+  # (hf://org/repo/path/to/file.hdf5).
+  path: hf://zeahub/camus-sample/val/patient0401/patient0401_4CH_half_sequence.hdf5
   # true: use local data on this device, false: use data from NAS
   local: false
-  # The form of data to load (raw_data, rf_data, iq_data, beamformed_data,
-  # envelope_data, image, image_sc)
-  dtype: image_sc
-  # The dynamic range for showing data in db [min, max]
-  dynamic_range: [-60, 0]
-  # The frame number to load when running the UI (null, int, 'all')
-  frame_no: all
-  # The type of data to convert to (raw_data, aligned_data, beamformed_data,
-  # envelope_data, image, image_sc)
-  to_dtype: image_sc
-
-# Settings pertaining to plotting when running the UI (`zea --config
-# <path-to-config.yaml>`)
-plot:
-  # Set to true to save the plots to disk, false to only display them in the UI
-  save: true
-  # The plotting library to use (opencv, matplotlib)
-  plot_lib: opencv
+  # Indices into the data to load. null loads the default, 'all' loads every
+  # frame, int loads a single frame, list loads specific frames.
+  indices: all

configs/config_carotid.yaml

@@ -1,36 +1,24 @@
 # config_carotid.yaml - comments were autogenerated from PARAMETER_DESCRIPTIONS in zea/config/parameters.py
-# The data section contains the parameters for the data.
+# Data path and loading settings.
 data:
-  # The path of the folder to load data files from (relative to the user data
-  # root as set in users.yaml)
-  dataset_folder: hf://zeahub/zea-carotid-2023
-  # The path of the file to load when running the UI (either an absolute path or
-  # one relative to the dataset folder)
-  file_path: 2_cross_bifur_right_0000.hdf5
+  # Full path to the data file. Supports absolute paths, paths relative to the
+  # user data root (set in users.yaml), and Hugging Face Hub paths
+  # (hf://org/repo/path/to/file.hdf5).
+  path: hf://zeahub/zea-carotid-2023/2_cross_bifur_right_0000.hdf5
   # true: use local data on this device, false: use data from NAS
   local: false
-  # The form of data to load (raw_data, rf_data, iq_data, beamformed_data,
-  # envelope_data, image, image_sc)
-  dtype: raw_data
-  # The dynamic range for showing data in db [min, max]
-  dynamic_range: [-40, 0]
-  # The frame number to load when running the UI (null, int, 'all')
-  frame_no: all
+  # Indices into the data to load. null loads the default, 'all' loads every
+  # frame, int loads a single frame, list loads specific frames.
+  indices: all
 
-# The parameters section is a flat mapping of scan/probe/custom parameters that
-# overwrite values loaded from the data file. Documented reconstruction
-# parameters are listed below; arbitrary custom parameters are also allowed.
+# Open mapping of scan/probe/custom parameters that overwrite values loaded from
+# the data file. ProbeSpec and ScanSpec are the authoritative sources for valid
+# parameter names — see the spec reference in data-acquisition. Arbitrary custom
+# parameters are forwarded to the pipeline unchanged.
 parameters:
-  # The number of transmits in a frame. Can be 'all' for all transmits, an
-  # integer for a specific number of transmits selected evenly from the
-  # transmits in the frame, or a list of integers for specific transmits to
-  # select from the frame.
-  selected_transmits: all # 149 is all or 11 for instance for reduce number of Tx
-  # The number of channels in the raw data (1 for rf data, 2 for iq data)
+  selected_transmits: all
   n_ch: 1
-  # The number of pixels in the beamforming grid in the x-direction
   grid_size_x: 400
-  # The number of pixels in the beamforming grid in the z-direction
   grid_size_z: 600
 
 # This section contains the necessary parameters for building the pipeline.
@@ -48,17 +36,5 @@ pipeline:
     - name: normalize
     - name: log_compress
 
-# The device to run on ('cpu', 'gpu:0', 'gpu:1', ...)
+# The device to run on ('cpu', 'gpu:0', 'gpu:1', 'auto:1', ...)
 device: auto:1
-
-# Settings pertaining to plotting when running the UI (`zea --config
-# <path-to-config.yaml>`)
-plot:
-  # Set to true to save the plots to disk, false to only display them in the UI
-  save: true
-  # The plotting library to use (opencv, matplotlib)
-  plot_lib: opencv
-  # Set to true to run the UI in headless mode
-  headless: false
-  # The name for the plot
-  tag: carotid

configs/config_echonet.yaml

@@ -1,35 +1,23 @@
 # config_echonet.yaml - comments were autogenerated from PARAMETER_DESCRIPTIONS in zea/config/parameters.py
-# The data section contains the parameters for the data.
+# Data path and loading settings.
 data:
-  # The path of the folder to load data files from (relative to the user data
-  # root as set in users.yaml)
-  dataset_folder: echonet_v2025/train
-  # The path of the file to load when running the UI (either an absolute path or
-  # one relative to the dataset folder)
-  file_path: 0X1A8F20B8BF0B4B45.hdf5
+  # Full path to the data file. Supports absolute paths, paths relative to the
+  # user data root (set in users.yaml), and Hugging Face Hub paths
+  # (hf://org/repo/path/to/file.hdf5).
+  path: echonet_v2025/train/0X1A8F20B8BF0B4B45.hdf5
   # true: use local data on this device, false: use data from NAS
   local: false
-  # The form of data to load (raw_data, rf_data, iq_data, beamformed_data,
-  # envelope_data, image, image_sc)
-  dtype: image
-  # The dynamic range for showing data in db [min, max]
-  dynamic_range: [-60, 0]
-  # The frame number to load when running the UI (null, int, 'all')
-  frame_no: all
-  # The type of data to convert to (raw_data, aligned_data, beamformed_data,
-  # envelope_data, image, image_sc)
-  to_dtype: image_sc
+  # Indices into the data to load. null loads the default, 'all' loads every
+  # frame, int loads a single frame, list loads specific frames.
+  indices: all
 
-# The parameters section is a flat mapping of scan/probe/custom parameters that
-# overwrite values loaded from the data file. Documented reconstruction
-# parameters are listed below; arbitrary custom parameters are also allowed.
+# Open mapping of scan/probe/custom parameters that overwrite values loaded from
+# the data file. ProbeSpec and ScanSpec are the authoritative sources for valid
+# parameter names — see the spec reference in data-acquisition. Arbitrary custom
+# parameters are forwarded to the pipeline unchanged.
 parameters:
-  # The range of theta values in radians for scan conversion (null, [min, max]).
-  theta_range: [-0.78, 0.78] # [-45, 45] in rads
-  # The range of rho values in meters for scan conversion (null, [min, max]).
+  theta_range: [-0.78, 0.78]
   rho_range: [0, 1]
-  # Value to fill the image with outside the defined region (float, default
-  # 0.0).
   fill_value: -60
 
 # This section contains the necessary parameters for building the pipeline.
@@ -40,11 +28,3 @@ pipeline:
     - name: scan_convert
       params:
         jit_compile: false
-
-# Settings pertaining to plotting when running the UI (`zea --config
-# <path-to-config.yaml>`)
-plot:
-  # Set to true to save the plots to disk, false to only display them in the UI
-  save: true
-  # The plotting library to use (opencv, matplotlib)
-  plot_lib: opencv

configs/config_echonetlvh.yaml

@@ -1,35 +1,23 @@
 # config_echonetlvh.yaml - comments were autogenerated from PARAMETER_DESCRIPTIONS in zea/config/parameters.py
-# The data section contains the parameters for the data.
+# Data path and loading settings.
 data:
-  # The path of the folder to load data files from (relative to the user data
-  # root as set in users.yaml)
-  dataset_folder: echonetlvh_v2025/train
-  # The path of the file to load when running the UI (either an absolute path or
-  # one relative to the dataset folder)
-  file_path: 0X1017398D3C3F5FF9.hdf5
+  # Full path to the data file. Supports absolute paths, paths relative to the
+  # user data root (set in users.yaml), and Hugging Face Hub paths
+  # (hf://org/repo/path/to/file.hdf5).
+  path: echonetlvh_v2025/train/0X1017398D3C3F5FF9.hdf5
   # true: use local data on this device, false: use data from NAS
   local: false
-  # The form of data to load (raw_data, rf_data, iq_data, beamformed_data,
-  # envelope_data, image, image_sc)
-  dtype: image
-  # The dynamic range for showing data in db [min, max]
-  dynamic_range: [-60, 0]
-  # The frame number to load when running the UI (null, int, 'all')
-  frame_no: all
-  # The type of data to convert to (raw_data, aligned_data, beamformed_data,
-  # envelope_data, image, image_sc)
-  to_dtype: image_sc
+  # Indices into the data to load. null loads the default, 'all' loads every
+  # frame, int loads a single frame, list loads specific frames.
+  indices: all
 
-# The parameters section is a flat mapping of scan/probe/custom parameters that
-# overwrite values loaded from the data file. Documented reconstruction
-# parameters are listed below; arbitrary custom parameters are also allowed.
+# Open mapping of scan/probe/custom parameters that overwrite values loaded from
+# the data file. ProbeSpec and ScanSpec are the authoritative sources for valid
+# parameter names — see the spec reference in data-acquisition. Arbitrary custom
+# parameters are forwarded to the pipeline unchanged.
 parameters:
-  # The range of theta values in radians for scan conversion (null, [min, max]).
-  theta_range: [-0.78, 0.78] # [-45, 45] in rads
-  # The range of rho values in meters for scan conversion (null, [min, max]).
+  theta_range: [-0.78, 0.78]
   rho_range: [0, 256]
-  # Value to fill the image with outside the defined region (float, default
-  # 0.0).
   fill_value: -60
 
 # This section contains the necessary parameters for building the pipeline.
@@ -41,11 +29,3 @@ pipeline:
       params:
         jit_compile: false
         order: 2
-
-# Settings pertaining to plotting when running the UI (`zea --config
-# <path-to-config.yaml>`)
-plot:
-  # Set to true to save the plots to disk, false to only display them in the UI
-  save: true
-  # The plotting library to use (opencv, matplotlib)
-  plot_lib: opencv

configs/config_picmus_iq.yaml

@@ -1,44 +1,26 @@
 # config_picmus_iq.yaml - comments were autogenerated from PARAMETER_DESCRIPTIONS in zea/config/parameters.py
-# The data section contains the parameters for the data.
+# Data path and loading settings.
 data:
-  # The path of the folder to load data files from (relative to the user data
-  # root as set in users.yaml)
-  dataset_folder: hf://zeahub/picmus/database/simulation/contrast_speckle/contrast_speckle_simu_dataset_iq
-  # The path of the file to load when running the UI (either an absolute path or
-  # one relative to the dataset folder)
-  file_path: contrast_speckle_simu_dataset_iq.hdf5
+  # Full path to the data file. Supports absolute paths, paths relative to the
+  # user data root (set in users.yaml), and Hugging Face Hub paths
+  # (hf://org/repo/path/to/file.hdf5).
+  path: hf://zeahub/picmus/database/simulation/contrast_speckle/contrast_speckle_simu_dataset_iq/contrast_speckle_simu_dataset_iq.hdf5
   # true: use local data on this device, false: use data from NAS
   local: false
-  # The form of data to load (raw_data, rf_data, iq_data, beamformed_data,
-  # envelope_data, image, image_sc)
-  dtype: raw_data
-  # The dynamic range for showing data in db [min, max]
-  dynamic_range: [-60, 0]
 
-# The parameters section is a flat mapping of scan/probe/custom parameters that
-# overwrite values loaded from the data file. Documented reconstruction
-# parameters are listed below; arbitrary custom parameters are also allowed.
+# Open mapping of scan/probe/custom parameters that overwrite values loaded from
+# the data file. ProbeSpec and ScanSpec are the authoritative sources for valid
+# parameter names — see the spec reference in data-acquisition. Arbitrary custom
+# parameters are forwarded to the pipeline unchanged.
 parameters:
-  # The number of transmits in a frame. Can be 'all' for all transmits, an
-  # integer for a specific number of transmits selected evenly from the
-  # transmits in the frame, or a list of integers for specific transmits to
-  # select from the frame.
   selected_transmits: all
-  # The number of pixels in the beamforming grid in the x-direction
   grid_size_x: 300
-  # The number of pixels in the beamforming grid in the z-direction
   grid_size_z: 500
-  # Set to true to apply lens correction in the time-of-flight calculation
   apply_lens_correction: false
-  # The speed of sound in the lens in m/s. Usually around 1000 m/s
   lens_sound_speed: 1000
-  # The thickness of the lens in meters
   lens_thickness: 0.001
-  # The limits of the z-axis in the scan in meters (null, [min, max])
   zlims: [0.006, 0.055]
-  # The limits of the x-axis in the scan in meters (null, [min, max])
   xlims: [-0.02, 0.02]
-  # The number of channels in the raw data (1 for rf data, 2 for iq data)
   n_ch: 2
 
 # This section contains the necessary parameters for building the pipeline.
@@ -55,15 +37,5 @@ pipeline:
     - name: normalize
     - name: log_compress
 
-# The device to run on ('cpu', 'gpu:0', 'gpu:1', ...)
+# The device to run on ('cpu', 'gpu:0', 'gpu:1', 'auto:1', ...)
 device: auto:1
-
-# Settings pertaining to plotting when running the UI (`zea --config
-# <path-to-config.yaml>`)
-plot:
-  # Set to true to save the plots to disk, false to only display them in the UI
-  save: true
-  # The plotting library to use (opencv, matplotlib)
-  plot_lib: matplotlib
-  # The name for the plot
-  tag: test

configs/config_picmus_rf.yaml

@@ -1,45 +1,26 @@
 # config_picmus_rf.yaml - comments were autogenerated from PARAMETER_DESCRIPTIONS in zea/config/parameters.py
-# The data section contains the parameters for the data.
+# Data path and loading settings.
 data:
-  # The path of the folder to load data files from (relative to the user data
-  # root as set in users.yaml)
-  dataset_folder: hf://zeahub/picmus/database/simulation/contrast_speckle/contrast_speckle_simu_dataset_rf
-  # The path of the file to load when running the UI (either an absolute path or
-  # one relative to the dataset folder)
-  file_path: contrast_speckle_simu_dataset_rf.hdf5
+  # Full path to the data file. Supports absolute paths, paths relative to the
+  # user data root (set in users.yaml), and Hugging Face Hub paths
+  # (hf://org/repo/path/to/file.hdf5).
+  path: hf://zeahub/picmus/database/simulation/contrast_speckle/contrast_speckle_simu_dataset_rf/contrast_speckle_simu_dataset_rf.hdf5
   # true: use local data on this device, false: use data from NAS
   local: false
 
-  # The form of data to load (raw_data, rf_data, iq_data, beamformed_data,
-  # envelope_data, image, image_sc)
-  dtype: raw_data
-  # The dynamic range for showing data in db [min, max]
-  dynamic_range: [-50, 0]
-
-# The parameters section is a flat mapping of scan/probe/custom parameters that
-# overwrite values loaded from the data file. Documented reconstruction
-# parameters are listed below; arbitrary custom parameters are also allowed.
+# Open mapping of scan/probe/custom parameters that overwrite values loaded from
+# the data file. ProbeSpec and ScanSpec are the authoritative sources for valid
+# parameter names — see the spec reference in data-acquisition. Arbitrary custom
+# parameters are forwarded to the pipeline unchanged.
 parameters:
-  # The number of transmits in a frame. Can be 'all' for all transmits, an
-  # integer for a specific number of transmits selected evenly from the
-  # transmits in the frame, or a list of integers for specific transmits to
-  # select from the frame.
   selected_transmits: all
-  # The number of pixels in the beamforming grid in the x-direction
   grid_size_x: 400
-  # The number of pixels in the beamforming grid in the z-direction
   grid_size_z: 600
-  # The number of channels in the raw data (1 for rf data, 2 for iq data)
   n_ch: 1
-  # Set to true to apply lens correction in the time-of-flight calculation
   apply_lens_correction: false
-  # The speed of sound in the lens in m/s. Usually around 1000 m/s
   lens_sound_speed: 1000
-  # The thickness of the lens in meters
   lens_thickness: 0.001
-  # The limits of the z-axis in the scan in meters (null, [min, max])
   zlims: [0.006, 0.055]
-  # The limits of the x-axis in the scan in meters (null, [min, max])
   xlims: [-0.02, 0.02]
 
 # This section contains the necessary parameters for building the pipeline.
@@ -60,15 +41,5 @@ pipeline:
     - name: normalize
     - name: log_compress
 
-# The device to run on ('cpu', 'gpu:0', 'gpu:1', ...)
+# The device to run on ('cpu', 'gpu:0', 'gpu:1', 'auto:1', ...)
 device: auto:1
-
-# Settings pertaining to plotting when running the UI (`zea --config
-# <path-to-config.yaml>`)
-plot:
-  # Set to true to save the plots to disk, false to only display them in the UI
-  save: true
-  # The plotting library to use (opencv, matplotlib)
-  plot_lib: matplotlib
-  # The name for the plot
-  tag: picmus_rf

docs/source/_autosummary/zea.rst

@@ -34,7 +34,6 @@ zea
    display
    doppler
    func
-   interface
    io_lib
    log
    metrics

docs/source/_spec_ref.rst

@@ -71,6 +71,8 @@ Stored as HDF5 root-level attributes (not groups).
      - |badge-opt|
 
 
+.. _group-reference:
+
 Group reference
 ~~~~~~~~~~~~~~~