Configuration

Configuration#

The following environment variables can be set by the user to control C-Star behavior.

Frequent users may want to set preferred values for these variables in their .bash_profile or .zshrc files.

Tip

Use CSTAR_FF_CLI_ENV_SHOW=1 cstar env show --display export to generate a starter script.

Variable	Default	Effect
`CSTAR_`	unknown	unknown

Variable	Default	Effect
`CSTAR_CLI_DRY_RUN`	0	Set to 1 to short-circuit CLI operations after planning steps are completed
`CSTAR_CLI_VERBOSE`	0	Set to 1 to produce verbose CLI outputs.
`CSTAR_CLOBBER_WORKING_DIR`	0	Set to 1 to automatically clear the working directory specified in a blueprint before launching a SLURM job. Use at your own risk.
`CSTAR_FRESH_CODEBASES`	0	Set to 1 to automatically clear codebase directories and create fresh clones during each run. Otherwise, use code found in locations specified in ROMS_ROOT and ROMS_MARBL.
`CSTAR_IN_ACTIVE_ALLOCATION`	(no default)	Override behavior for launching new jobs via SLURM or simply executing via mpirun. Only set this to 0 if you need to launch new jobs from within an existing allocation.
`CSTAR_LOG_LEVEL`	INFO	Specify the logging level for terminal messages. Options: DEBUG, INFO, WARNING, ERROR, CRITICAL.
`CSTAR_NPROCS_POST`	<generated>	Specify the number of processes to be used for post-processing simulation output files. Dynamic default `os.cpu_count() // 3`
`CSTAR_RUNID`	<generated>	Unique run identifier used by the orchestrator.
`CSTAR_SLURM_POST_SUBMIT_DELAY`	1.0	Delay (in seconds) after a submission to ensure status for a SLURM job can be queried.

Variable	Default	Effect
`CSTAR_CACHE_HOME`	~/.cache or <generated>	Environment variable used to override the home directory for C-Star file cache.
`CSTAR_CONFIG_HOME`	~/.config or <generated>	Environment variable used to override the home directory for C-Star config storage.
`CSTAR_DATA_HOME`	~/.local/share or <generated>	Environment variable used to override the home directory for C-Star dataset storage.
`CSTAR_SCRATCH_DIRS`	SCRATCH,SCRATCH_DIR,LOCAL_SCRATCH	A comma-separated list of environment variable names used to identify scratch paths on HPC systems, in search order.
`CSTAR_STATE_HOME`	~/.local/state or <generated>	Environment variable used to override the home directory for C-Star state storage.

Variable	Default	Effect
`CSTAR_ORCH_DELAYS`	0.1, 1, 2, 5, 15, 30, 60	Configurable delay for the orchestrator (seconds).
`CSTAR_ORCH_TRX_FREQ`	Monthly	Time span for time-splitting transforms (e.g. Monthly, Yearly).
`CSTAR_SLURM_ACCOUNT`	(no default)	Account ID to be used by the SLURM scheduler.
`CSTAR_SLURM_MAX_WALLTIME`	48:00:00	Maximum walltime allowed by the SLURM scheduler.
`CSTAR_SLURM_QUEUE`	(no default)	SLURM priority (queue) used by the SLURM scheduler.

Variable	Default	Effect
`CSTAR_CMD_CONVERTER_OVERRIDE`	(no default)	Overridden mapping key to apply when converting applications into CLI commands.

Variable	Default	Effect
`CSTAR_FF_CLI_BP_MIGRATE_AUTO`	0	Enable automatic blueprint migration to the latest schema during execution.
`CSTAR_FF_CLI_BP_MIGRATE_SHOW`	0	Enable CLI for migrating blueprints to the latest schema.
`CSTAR_FF_CLI_ENV_SHOW`	0	Enable CLI for displaying environment configuration.
`CSTAR_FF_CLI_TEMPLATE_CREATE`	0	Enable CLI for creating blueprints and workplans from standard templates.
`CSTAR_FF_CLI_WORKPLAN_COMPOSE`	0	Enable CLI for composing a workplan from pre-existing blueprints.
`CSTAR_FF_CLI_WORKPLAN_GEN`	0	Enable CLI for generating a workplan from a directory of blueprints.
`CSTAR_FF_CLI_WORKPLAN_PLAN`	0	Enable CLI for generating the execution plan of a workplan.
`CSTAR_FF_CLI_WORKPLAN_STATUS`	0	Enable CLI for retrieving status about a workplan run.
`CSTAR_FF_DEVELOPER_MODE`	0	Enable developer mode to enable all feature flags (not recommended).
`CSTAR_FF_ORCH_TRX_TIMESPLIT`	0	Enable automatic time-splitting of simulations.
`CSTAR_FF_ORCH_TRX_TIMESPLIT_LONGNAME`	0	Enable long name generation during time-splitting.