vtr-verilog-to-routing icon indicating copy to clipboard operation
vtr-verilog-to-routing copied to clipboard

Published 20 hours ago • verified publisher icon verilog-to-routing

Quickstart, requirements, and flow tutorial update

Open nedsels opened this issue 9 months ago • 1 comments

  1. Quickstart now shows how to build for use with ODIN II
  2. Updated basic design flow tutorial to remove redundant instructions to run parse_vtr_task.py
  3. Changed version of black in requirements.txt to 21.4b0 so that make env works

Motivation and Context

  1. The quickstart guide did not tell users how to build to that ODIN II could be used for synthesis. They would have to go to the ODIN II page and see to navigate to the odin_ii directory and make build. The new command in the quickstart guide allows them to build ODIN II when they build VTR.
  2. There was an instruction to run parse_vtr_task.py in the Basic Design Flow Tutorial, the reason being it created a parse_results.txt file, but this is already created by the earlier run_vtr_task.py
  3. make env did not work with the previous version of black, 20.8b1

How Has This Been Tested?

  1. I ran make env with the new version of black, and there are no errors.

Types of changes

  • [x] Bug fix (change which fixes an issue)
  • [ ] New feature (change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • [ ] My change requires a change to the documentation
  • [x] I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • [ ] All new and existing tests passed

nedsels avatar May 09 '24 16:05 nedsels

@vaughnbetz What do you think about these changes? This resolves the black version which was causing make env not to work properly and resolves some inconsistencies with how run_vtr_task.py is introduced.

See issue #2548

AlexandreSinger avatar May 09 '24 20:05 AlexandreSinger

@vaughnbetz Please review

nedsels avatar May 10 '24 17:05 nedsels

Looks good and merging. One enhancement we should do next though -- we should change to synthesizing with parmys, as it is now the default synthesis flow. Basically replace the Odin II section with the parmys equivalent. The Odin II part can be moved to an optional section at the end of the quick start or (even better) a quick start at the beginning of the Odin II documentation.

vaughnbetz avatar May 10 '24 19:05 vaughnbetz