cli.RunConfig

cli.RunConfig(
    script,
    simulation,
    replicates=1,
    data=dict(),
    custom_tags=dict(),
    crs=None,
    output_format=None,
    output=None,
    parallel=False,
    use_float64=False,
    verbose=False,
    upload_source=False,
    upload_config=False,
    upload_data=False,
    output_steps=None,
    seed=None,
)

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

See: https://joshsim.org/cli#run

Attributes

Name Type Description
script Path Path to Josh simulation file (.josh).
simulation str Name of simulation to execute.
replicates int Number of replicates to run.
data dict[str, Path] Map of data file names to paths (–data name=path).
custom_tags dict[str, str] Custom tags for template resolution (–custom-tag name=value).
crs str | None Coordinate Reference System.
output_format str | None Output format (csv, netcdf, geotiff).
output Path | None Output file path.
parallel bool Enable parallel patch processing.
use_float64 bool Use double precision instead of BigDecimal.
verbose bool Enable verbose output.
upload_source bool Upload source .josh file to MinIO after completion.
upload_config bool Upload configuration .jshc files to MinIO after completion.
upload_data bool Upload data .jshd files to MinIO after completion.
output_steps str | None Step range to output (e.g., “0-10,50,100”).
seed int | None Random seed for reproducibility.