Overview
/
Developer Tools
/
CLI
/
analyze

zoo kcl analyze

Analyze multiple physical properties of objects in a kcl file.

Options

input
The path to the input file. This can also be the path to a directory containing a main.kcl file. If you pass - as the path, the file will be read from stdin
--material-density
How dense is the material?
Default value: 1
--material-density-unit
What units are material-density measured in?
Default value: kg:m3
--format
How to present the data to stdout. Machine-friendly and human-friendly options
Possible values: json | yaml | table
--volume-output-unit
What units do you want volumes shown in?
Default value: m3
--mass-output-unit
What units do you want masses shown in?
Default value: kg
--density-output-unit
What units do you want densities shown in?
Default value: kg:m3
--surface-area-output-unit
What units do you want areas shown in?
Default value: m2
--center-of-mass-output-unit
What units do you want lengths shown in?
Default value: m
--show-trace
If true, print a link to this request's tracing data
Default value: false
--allow-errors
When there are KCL problems that are are errors, continue anyway. Problems (AKA compilation issues) may be detected in KCL parsing or execution and can have varying severity. Some errors are fatal and are not affected by this option. Which errors are considered fatal may change without notice
Default value: false
-d/--debug
Print debug info
Default value: false
--host
Zoo API host to use for all commands (e.g., "api.zoo.dev" or "http://localhost:8888"). Overrides the configured default host
-h/--help
Print help (see a summary with '-h')

About

This runs KCL once and then returns all requested analyses from the same scene.

analyze a file and print a table

$ zoo kcl analyze my-file.kcl --material-density 1.0 --material-density-unit lb-ft3

output for scripting

$ zoo kcl analyze my-file.kcl --format json --material-density 1.0 --material-density-unit lb-ft3

By default, this will search the input path for a project.toml file to determine any specific execution settings.

See also