diff --git a/README.md b/README.md index 0994fbf92d3026fe5b6ced17478b8210ab577be7..49cc92762121fa980b7589bd5652bf85ff58f69b 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,14 @@ lclayout --output-dir mylibrary --tech examples/dummy_tech.py --netlist examples ## Adapting design rules Design rulesi and technology related data need to be encoded in a Python script file as shown in `examples/dummy_tech.py`. +## Debugging +Getting the configuration right can be tricky. There's some debugging options which can +help inspecting the cell generation: +* `--verbose`: Print more debug information. +* `--debug-routing-graph`: Plot the full routing grid into the layout file. This helps understanding if the pitch and tracks are well aligned with the rest of the cell. +* `--debug-routing-iterations`: Plot the intermediate results of the router to files. This helps debugging the routing algorithm. +* `--debug-output-dir`: Directory where debug information will be written. + ### Known issues #### Reproducibility diff --git a/src/lclayout/standalone.py b/src/lclayout/standalone.py index aade14bb7dcead415afbf44671d881b4aa6ada90..41ea2c5dc99f3d868b1553a097ee6d4c0e4dc1cb 100644 --- a/src/lclayout/standalone.py +++ b/src/lclayout/standalone.py @@ -957,7 +957,7 @@ def main(): orientation_change_penalty=tech.orientation_change_penalty ) - if args.debug_visual: + if args.debug_routing_iterations: router = InspectRouter(router, output_dir = args.debug_output_dir) layouter = LcLayout(tech=tech,