Commit c8dac4f8 authored by VIGNET Pierre's avatar VIGNET Pierre
Browse files

Update Readme with examples & command line doc

parent 72de7760
......@@ -71,13 +71,88 @@ It contains the cadbiom folder with:
# Utilization
Run the following command in your shell:
make run
## GUI
or:
Run the following command in your shell:
python cadbiom_des.py
make run_gui
## Command line
General:
:::console
$ python cadbiom_cmd.py -h
usage: cadbiom_cmd.py [-h] [-vv [VERBOSE]]
{compute_macs,sort_solutions,parse_trajectories,merge_cams}
...
optional arguments:
-h, --help show this help message and exit
-vv [VERBOSE], --verbose [VERBOSE]
subcommands:
{compute_macs,sort_solutions,parse_trajectories,merge_cams}
compute_macs Parse arguments and launch Cadbiom search of MACs
(Minimal Activation Conditions). - If there is no
input file, there will be only one process. - If an
input file is given, there will be 1 process per line
(per logical formula on each line). - all_macs: Solver
will try to search all macs with 0 to the maximum of
steps allowed. - continue: If there is a mac file from
a previous work, last frontier places will be
reloaded.
sort_solutions Parse a solution file and sort all frontier places in
alphabetical order.
parse_trajectories Parse a complete solution file and make a
representation of trajectories.
The output is in graphml file format and is exported
in 'graphs' directory. .. note:: Requires the
model file.
merge_cams Merge solutions to a csv file. .. note:: CSV file:
<Final property formula>;<cam>
compute_macs:
:::console
usage: cadbiom_cmd.py compute_macs [-h] [--input_file [INPUT_FILE]]
[--combinations] [--steps [STEPS]]
[--all_macs] [--continue]
[--start_prop [START_PROP]]
[--inv_prop [INV_PROP]] [--output [OUTPUT]]
chart_file [final_prop]
positional arguments:
chart_file
final_prop
optional arguments:
-h, --help show this help message and exit
--input_file [INPUT_FILE]
--combinations
--steps [STEPS]
--all_macs
--continue
--start_prop [START_PROP]
--inv_prop [INV_PROP]
--output [OUTPUT]
parse_trajectories:
:::console
usage: cadbiom_cmd.py parse_trajectories [-h] chart_file sol_file
positional arguments:
chart_file
sol_file
<br>
Result:
<img alt="graph trajectory" src="./graphs/graph_example_with_legend.png" />
# License
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment