examples¶
This chapter serves to document several of the example usages
-
examples.examples.
run_example_binary
()¶ Function to run a binary system. Very basic approach which directly adresses the run_binary(..) python-c wrapper function.
-
examples.examples.
run_example_binary_with_custom_logging
()¶ Function that will use a automatically generated piece of logging code. Compile it, load it into memory and run a binary system. See run_system on how several things are done in the background here.
-
examples.examples.
run_example_binary_with_run_system
()¶ This function serves as an example on the function run_system and parse_output. There is more functionality with this method and several tasks are done behind the scene.
Requires pandas, numpy to run.
run_system: mostly just makes passing arguments to the function easier. It also loads all the necessary defaults in the background parse_output: Takes the raw output of binary_c and selects those lines that start with the given header. Note, if you dont use the custom_logging functionality binary_c should be configured to have output that starts with that given header
-
examples.examples.
run_example_binary_with_writing_logfile
()¶ Same as above but when giving the log_filename argument the log filename will be written
Checking if this works¶
..autofunction:: run_example_binary