This file contains information about how to setup and run the script.

The script entry point is from main.py. Run command 'py main.py' from the command line to execute the script.
All libraries need to be installed - see the attachment in the document to see all listed libraries.


--------------------------------------------------------------------------------------------------------------
------------------------------------------- How to run the script: -------------------------------------------
--------------------------------------------------------------------------------------------------------------
1. Run TCL command 'ngc2edif' on a file you want to run the script on.
2. Run Place & Route with advanced reporting enabled.
3. Set path to the design in settings.py.
4. Run the script.
--------------------------------------------------------------------------------------------------------------


--------------------------------------------------------------------------------------------------------------
------------------------------------------------- Settings: --------------------------------------------------
--------------------------------------------------------------------------------------------------------------
The user can adjust the script in the following ways:

1. List instances that will be excluded from graph assembly (e.g. 'XST_GND', 'XST_VCC').
2. Exclude pins in a flip-flop that will be excluded from graph assembly (e.g. 'CLR', 'PRE').
3. Ignore design signal paths that should be excluded from pipelining (e.g. 'SYS_CLK')
4. Ignore net delays so that Place & Route does not influence the delay (i.e. it does not matter if the logical elements are close to each other or not)
5. Draw graph - this is mostly for debugging purposes as the graphs get messy really fast
6. Set verbose printing to true/false
--------------------------------------------------------------------------------------------------------------