cli.BatchRemoteConfig

cli.BatchRemoteConfig(
    simulation,
    target,
    minio_prefix,
    replicates=1,
    no_wait=False,
    poll_interval=None,
    timeout=None,
    require_prestaged=False,
    custom_tags=dict(),
    replicate_start=0,
    replicate_indices=None,
)

Arguments for ‘java -jar joshsim.jar batchRemote’ command.

Mirrors josh’s CLI surface. joshpy’s staging model is always explicit two-step: caller uploads inputs via :meth:JoshCLI.stage_to_minio, then dispatches via :meth:JoshCLI.batch_remote with require_prestaged=True to verify the sentinel before the remote target starts.

Attributes

Name	Type	Description
simulation	str	Name of simulation to run.
target	str	Target profile name (required).
minio_prefix	str	MinIO object prefix where inputs already live (e.g. batch-jobs/my-run/inputs/). Must have the staging sentinel present if require_prestaged=True.
replicates	int	Number of replicates (default: 1).
no_wait	bool	If True, dispatch and exit without polling (default: False).
poll_interval	int | None	Polling interval in seconds (optional).
timeout	int | None	Job timeout in seconds (optional).
require_prestaged	bool	Fail fast unless the staging sentinel at minio_prefix reports complete. Recommended for sweeps; run_sweep sets this to True by default via :func:joshpy.jobs.to_batch_remote_config.
custom_tags	dict[str, str]	Custom tags for template resolution (--custom-tag name=value). Pods receive these via the runtime’s custom-tag propagation mechanism and resolve {name} references in export paths. joshpy’s :func:joshpy.jobs.to_batch_remote_config auto-injects run_hash so users can write exportFiles.patch = "minio://bucket/{run_hash}/output_{replicate}.csv" for deterministic per-simulation paths.
replicate_start	int	Offset added to each pod’s replicate index. When K, pods run as replicates K..K+replicates-1 (instead of 0..replicates-1).
replicate_indices	list[int] | None	Explicit, possibly non-contiguous replicate indices to run (--replicate-indices=3,7,8). When set, supersedes replicates/replicate_start — used by the pool collision policy to backfill exactly the missing replicate indices.