Skip to content

Settings Reference ​

Every setting the extension reads, in one place. Each entry gives the default and what changing it does; the guide pages linked from each row explain the feature behind it. All sixteen live under the kratos prefix in VS Code's settings.

SettingDefaultWhat it does
kratos.showWhatsNewtrueShow the What's New screen after the extension updates, summarizing the changelog entries newer than the version you last saw. Reopen it any time with Kratos MDPA: Show What's New.
kratos.pythonPath""Python executable used to run cases (python MainKratos.py). Leave empty to use python3 (python on Windows). Point it at the interpreter where Kratos is pip-installed, or at any python when kratos.installPath is set. See Running a Case.
kratos.installPath""Root of a compiled Kratos install (the directory containing KratosMultiphysics/ and libs/) — a Kratos source checkout also works, its bin/Release/bin/Debug build output is auto-detected. Added to PYTHONPATH and the platform's shared-library path when running a case. Set it with Kratos Case: Select Kratos Installation Folder…, or leave empty for a pip-installed Kratos. See Simulation.
kratos.extraEnv{}Extra environment variables for the run terminal, e.g. {"OMP_NUM_THREADS": "4"}. Set verbatim, overriding computed values. See Simulation.
kratos.problemtypes.extraPaths[".kratos/problemtypes"]Directories scanned for user problemtype definitions (*.js / *.py), relative to each workspace folder (absolute paths allowed). See Authoring Problemtypes.
kratos.materials.extraPaths[".kratos/materials"]Directories scanned for material presets (*.json), relative to each workspace folder (absolute paths allowed). See Simulation.
kratos.recipes.extraPaths[".kratos/recipes"]Directories scanned for batch recipe presets (*.json), relative to each workspace folder (absolute paths allowed). See Batch Transform.
kratos.flowgraph.splitOrientation"horizontal"Default split direction when the Flowgraph problemtype is selected: horizontal puts the node editor below the mesh view, vertical puts it beside. Toggleable live from the pane. See Flowgraph.
kratos.flowgraph.assetPathOverride""Advanced, development only: absolute path to a local @kratos-flowgraph/flowgraph checkout (the folder containing public/ and views/) to serve instead of the bundled copy. Leave empty to use the bundled assets. Only useful when hacking on Flowgraph itself.
kratos.preview.autoSavefalseLet VS Code's file auto-save write mesh previews back to disk. Off by default: saving a preview re-serialises the whole mesh over the source file and can drop comments and formatting, and the one-time overwrite warning is not shown again once accepted — so with auto-save enabled every edit would silently rewrite the file you opened. When off, an automatic save is refused and the tab simply stays marked as unsaved; Ctrl+S and File ▸ Save still work.
kratos.export.provenance"auto"Where an export records its provenance. Native MDPA, VTK XML (including VTM children), OBJ and PLY embed safe comments; legacy VTK uses a 255-byte title and warns on truncation. STL and temporal XDMF have no embedding slot: use sidecar for their complete record. sidecar also writes <output>.kratosexport.json with the full report (one roll-up per series); none adds no new provenance or sidecar. The Export Report panel shows retained/transformed/omitted/unverified data regardless. See Export Report.
kratos.preview.summaryThresholdMb250Show a header summary instead of loading a mesh larger than this many megabytes — counts, entity blocks and data-array names, with an Open full mesh anyway button. Set to 0 to always load the full mesh. What a summary actually costs depends on the format; the preview says which. See Header Summary.
kratos.preview.frameCacheMb256Memory budget for keeping recently viewed timeline frames parsed in the extension host, so stepping back and forth through a series does not re-read the files; the next frame is read ahead while one plays. 0 turns it off. The cache is emptied whenever the files on disk change, and edits are replayed onto a cached frame as onto a fresh one.
kratos.plots.persistentCachefalseKeep a bounded on-disk cache (256 MiB, 512 entries) of disk-backed Plots extractions — mesh tables, probe profiles, regional quantities and histories — under the extension's global storage, so reopening a plot after a restart does not reread the files. An entry is reused only while the source, its companion files and its timeline have exactly the content it was built from; any change, addition or missing file is a miss. Live-mesh snapshots and fixed profile-following snapshots are never cached on disk. Off by default. See Scientific Plots.
kratos.preview.renderer"vtkjs"Rendering backend for mesh previews. "vtkwasm" is the experimental alternative: VTK's own renderer compiled to WebAssembly, shipped with the extension, opt-in. If VTK-wasm cannot start, the preview falls back to vtk.js and says why. Applies to previews opened after it changes. See Rendering Backend.
kratos.run.launchMode"output"How Run case launches the solver. output runs it as a tracked child process with its output in an Output channel: real exit code, live progress, working Stop. terminal runs it in an integrated terminal: interactive (prompts, conda activate) but untracked. See Running a Case.
kratos.run.stopOnWindowClosetrueStop running solvers when the window closes or reloads. Turn it off to let a solve continue in the background — it is then detached, and the extension can no longer report its exit code. See Running a Case.

Released under the GNU AGPL-3.0-or-later License.