pypeec.script

Module containing the command line script.

  • Used for calling the mesher, solver, viewer, and plotter.

  • Parse the command line arguments.

  • Call the corresponding entry point.

pypeec.script.run_arguments(argv)
User script for running PyPEEC with given arguments.

  • The script offers a CLI for the mesher, solver, viewer, and plotter.

  • The script can also be used to extract data (examples, documentation, and logger config).

Parameters:

argv (list) – List with the command line arguments.

Returns:

status – The status exit code of the script.

Return type:

int

pypeec.script.run_script()
User script for running PyPEEC with the command line arguments.

  • The script offers a CLI for the mesher, solver, viewer, and plotter.

  • The script can also be used to extract data (examples, documentation, and logger config).

The script is installed with the package. The name of the command line script is “pypeec”.