Skip to content

Quickstart, requirements, and flow tutorial update #2550

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 3 commits into from
May 10, 2024

Conversation

nedsels
Copy link
Contributor

@nedsels nedsels commented May 9, 2024

  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

  • 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
  • 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 docs Documentation Parmys labels May 9, 2024
@AlexandreSinger AlexandreSinger self-requested a review May 9, 2024 18:06
@nedsels nedsels force-pushed the update_quickstart_fix branch from 59e2a3d to fec9e43 Compare May 9, 2024 19:26
@nedsels nedsels force-pushed the update_quickstart_fix branch 2 times, most recently from dfef2e6 to 6a6da7d Compare May 9, 2024 19:58
@AlexandreSinger
Copy link
Contributor

@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

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.

This is a good start. Please see my comment below.

…how to build if they will be using ODIN II for synthesis
@nedsels nedsels force-pushed the update_quickstart_fix branch from 6a6da7d to e5d90af Compare May 9, 2024 21:30
@nedsels
Copy link
Contributor Author

nedsels commented May 10, 2024

@vaughnbetz Please review

@vaughnbetz
Copy link
Contributor

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 vaughnbetz merged commit 8fe7da8 into verilog-to-routing:master May 10, 2024
52 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants