Named Configs

Click any command card below to expand its full parameter reference.

Info

Note that all cards below are auto-generated from EuBIBridge methods and Pydantic config models. Types, defaults, and valid ranges are extracted directly from the source.

with_config — Return a new EuBIBridge backed by the named config file

Usage:

eubi with_config NAME [OPTIONS]

All parameters in the named config are used as defaults; any arguments passed directly to to_zarr() (or other commands) still take priority. Designed for Fire chaining:

eubi with_config hpc to_zarr input/ output/

Required arguments

--name

Type:  str

Default:  required

Name of a saved config profile (without the .json extension), e.g. hpc. Must already exist — create profiles with save_as or update_config --create.

# Use the 'hpc' profile for one conversion run
eubi with_config hpc to_zarr /data/input /data/output

# Combine a named config with an inline override
eubi with_config hpc to_zarr /data/input /data/output --ome_zarr_version 0.5

save_as — Save the current config as a named config file

Usage:

eubi save_as NAME [OPTIONS]

Required arguments

--name

Type:  str

Default:  required

Profile name to save under (without the .json extension), e.g. hpc. May contain only letters, digits, hyphens, and underscores. Overwrites an existing profile of the same name.

# Save the current configuration as a profile named 'hpc'
eubi save_as hpc

update_config — Copy the current config into a named config or an explicit file path

Usage:

eubi update_config NAME_OR_PATH [OPTIONS]

Typical use: propagate default-config edits to a named config:

eubi configure cluster --max_workers 64   # edits .eubi_config.json
eubi update_config hpc                     # copies it to hpc.json

Required arguments

--name_or_path

Type:  str

Default:  required

Target to write the current config into. A bare name (e.g. hpc) is resolved in the named-config registry; a value containing a path separator or ending in .json is treated as a literal filesystem path.

# Propagate edits from the active config into the 'hpc' profile
eubi update_config hpc

# Write to an explicit file path instead of a named profile
eubi update_config /data/configs/hpc.json

Optional arguments

--create

Type:  boolean flag

Default:  False

Valid values:  --create to enable  ·  --create False to disable

When True, create the target profile / file if it does not already exist (default False raises if missing).

# Create the target profile if it does not exist yet
eubi update_config hpc --create

list_configs — Return {name: path} for all named configs in the config directory

Usage:

eubi list_configs [OPTIONS]

show_configs — List all named config files found in the config directory

Usage:

eubi show_configs [OPTIONS]

Prints a table of {name: path} entries. Use with_config NAME to activate one of them for a single command, or save_as / update_config to manage them.

delete_config — Permanently delete a named config file from the config directory

Usage:

eubi delete_config NAME [OPTIONS]

The active (default) config is not affected. Only named configs created with save_as or update_config --create can be deleted this way.

Required arguments

--name

Type:  str

Default:  required

Short name of the config to delete (without the .json extension), e.g. hpc.

# Permanently remove the 'hpc' profile
eubi delete_config hpc