cli¶

Command-line interface for VisFEM.

Usage

visfem # launch the web app (same as visfem serve) visfem renderers # list the built-in renderers and what each is for visfem schema # reference of the dataset JSON fields visfem example # print a minimal valid dataset JSON for a renderer visfem new-dataset NAME # scaffold a dataset folder and JSON template visfem validate-data # validate every dataset JSON and its referenced files visfem fetch-ircadb # download the public 3D-IRCADb-01 example dataset visfem fetch-openknee # download the Open Knee(s) knee geometries from SimTK

The data-authoring commands read and write the data directory: DATA_DIR or VISFEM_DATA_DIR, else the bundled data.

cmd_renderers ¶

cmd_renderers(_args)

Print the built-in renderers with a one-line description each; returns 0.

cmd_validate_data ¶

cmd_validate_data(_args)

Validate every dataset JSON and check its mesh files exist; returns 1 on a problem, else 0.

cmd_schema ¶

cmd_schema(_args)

Print a reference of the dataset JSON fields; returns 0.

cmd_example ¶

cmd_example(args)

Print the minimal valid dataset JSON for args.renderer; returns 0.

cmd_new_dataset ¶

cmd_new_dataset(args)

Scaffold datasets//.json from a template; returns 1 when it exists or name is no valid key, else 0.

cmd_fetch_ircadb ¶

cmd_fetch_ircadb(args)

Download 3D-IRCADb-01 and lay it out as a VisFEM dataset; returns 1 on error, else 0.

parse_connectivity ¶

parse_connectivity(xml_text)

Map part code -> meshed surface filename from an Open Knee(s) Connectivity.xml xml_text.

openknee_specimen_descriptor ¶

openknee_specimen_descriptor(specimen)

Return the dataset JSON for one Generation 2 specimen.

openknee_gen1_descriptor ¶

openknee_gen1_descriptor()

Return the dataset JSON for the Generation 1 tibiofemoral FEBio model.

cmd_fetch_openknee ¶

cmd_fetch_openknee(args)

Fetch Open Knee(s) datasets; returns 2 for an unknown specimen, 1 on error, else 0.

build_parser ¶

build_parser()

Return the visfem parser; each subparser sets func and the commands default lists every subcommand.

main ¶

main(argv=None)

Run the CLI on argv (default sys.argv[1:]) and return the exit code.