DOCS // geofx

geofx errors and exit codes Available

geofx names invalid keys and missing inputs in its report. Exit code 5 means the compile finished but missed a budget limit.

Contents3 sections
  1. Errors and exits
  2. Warnings and settings
  3. Questions

geofx runs on the hosted API: try it in the Playground.

Errors and exits

ExitCodesMeaning
0Done. Warnings, if any, are in the report.
1SOURCE_MISSING, GRID_NOT_WHOLE, DRAW_CELL_NOT_NESTED, STAMP_CELL_NOT_NESTED, GRID_MISMATCH, FIXED_HEIGHT_CONVERT, FIXED_HEIGHT_CONFLICT, WORLD_TOO_LARGE, MATERIAL_UNKNOWN, TARGET_LIMITThe spec or the command is wrong; the message names the key and what it accepts.
2STAGE_FAILED, OUT_OF_MEMORYA step could not make a valid result.
3FILE_READ, FILE_WRITE, HEIGHT_UNREADABLE, IMAGE_UNREADABLE, LAYOUT_INVALIDA file could not be read, used or written; the message names it.
4NO_GPUOnly for an unbuilt stage.
5BUDGET_EXCEEDEDThe run finished and wrote every file, but missed a [budget] limit.

Warnings and settings

WarningKey to change
FLAT_TERRAINshape.amplitude_m
OVER_ERODEDerosion.iterations, erosion.strength
SPIKESerosion.thermal_rate, source.height
CONSTRAINT_BROKENconstraints.tolerance_m, constraints.falloff_m
MESH_ERROR_HIGHmesh.max_error_m
EDGE_ARTIFACTSgrid.tiling, erosion.apron_m
HEIGHT_CLIPPEDgrid.height_range_m
HEIGHT_STEP_COARSEgrid.height_range_m
HEIGHT_QUANTISEDsource.height
DETAIL_CLAMPEDdraw.detail_max_m
MATERIAL_UNCOVEREDmaterials.weight
MATERIAL_LAYERS_DROPPEDmaterial_map.encoding
WETNESS_SATURATEDwetness.twi_range
TILE_ALONEgrid.tiles
FIXED_HEIGHT_KEPTsource.height_mode
STAMP_CLIPPEDstamps.crater_ejecta
STAMP_VOLUMEstamps.crater_rim
TEXTURE_DOWNSIZEDdraw.cell_m
TARGET_RESAMPLEDexport.targets
STAGE_NOT_BUILTerosion.enabled

Read the full report before using a result. A finished compile can still miss a budget; exit code 5 keeps all output files.

Questions

What does exit code 5 mean on a geofx compile?

Exit code 5 means the compile finished and wrote every output file, but missed a limit set in the budget section.

Which exit codes indicate invalid geofx specs or unreadable files?

Exit code 1 reports an invalid spec key or value, while exit code 3 means an input or output file could not be read or written.

How do you fix a HEIGHT_CLIPPED or SPIKES warning in geofx?

Adjust grid.height_range_m to fix HEIGHT_CLIPPED warnings or tune erosion.thermal_rate and source.height to resolve SPIKES warnings.