Skip to content

[QuickStart] Yosys/Parmys Update #2776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Nov 18, 2024

Conversation

ZohairZaidi
Copy link
Contributor

Description

This pull request updates the VTR Quick Start Guide by replacing Odin II as the primary synthesis tool with the Yosys/Parmys flow. I have also updated the graphic images

Related Issue

closes #2739

Checklist:

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

@github-actions github-actions bot added the docs Documentation label Oct 16, 2024
Copy link
Contributor

@vaughnbetz vaughnbetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ZohairZaidi !
I have some comments about the parmys flow (I think we've listed some unnecessary steps for it) that you should take a look at closely. Adding @amirarjmand93 and @KennethKent to review; in case @AlexandreSinger has time to review I've tagged him too

@ZohairZaidi
Copy link
Contributor Author

Thanks @vaughnbetz!, I have addressed your suggestions. Will wait for the added members to review as well.

Copy link
Contributor

@AlexandreSinger AlexandreSinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ZohairZaidi Thank you for these changes! I like how you are running Yosys. I think using the vtr_flow script just on the Yosys step is perfectly fine since running Yosys directly is such a pain. The main goal is to know how to make the .blif file.

I have left some comments below, but overall the documentation is very good.

@vaughnbetz
Copy link
Contributor

Adding @soheilshahrouz in case he can help figure out the required flow ... we need to document this well in the quickstart as Mohamed and I were confused about it.

@ZohairZaidi
Copy link
Contributor Author

I agree @vaughnbetz, I plan to work on it this reading week. Please let me know what you were confused about.

@ZohairZaidi
Copy link
Contributor Author

Hi @vaughnbetz, let me know how this is. I changed the order and made it smoother for the user to follow.

Copy link
Contributor

@vaughnbetz vaughnbetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, thanks! I just have a couple of minor comments / changes to link up the first couple of sections.

blink --circuit_file $VTR_FLOW_DIR/temp/blink.pre-vpr.blif \
--route_chan_width 100 \
--analysis --disp on


Running VPR
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should rename this to "Running VPR Manually"
and then add a first sentence after the heading that says
"Sometimes you may wish to run only the vpr (placement, routing and timing analysis) parts of the flow rather than the full VTR flow (which includes synthesis). To show how to do this, let's now try taking ..."

@vaughnbetz
Copy link
Contributor

Looks good, thanks!

@vaughnbetz vaughnbetz merged commit 2ce2c6f into verilog-to-routing:master Nov 18, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update VTR quick start guide to use yosys / parmys
4 participants