usage of packages and tool classes

[csquaredphd]

I'm looking for clarification on the intended usage of the multiple packages (edalize, edalize.tools, edalize.flows). I have searched the code, issues, and Wiki and understand that edalize.flows is the newest API (which I think is a good move, BTW). The distinction is less clear between edalize and edalize.tools.

For example, if one wanted to add new tool options to Vivado and Yosys, to which package(s) should they be added?

Which package should a newly developed project that incorporates edalize use?

[olofk]

The classes directly under edalize are part of the old tool API. The new API consists of flows (in edalize.flows that uses the tool classes from edalize.tools.

A newly developed project should go with the flow API (i.e. the classes under edalize.flows and edalize.tools). At this point in time, not all of the tools have yet been converted to the flow API but both Vivado and yosys should be fine. One complication arises if you're using FuseSoC as the frontend to Edalize (which I don't think you do?), because there is no way yet to use the Edalize flow API from FuseSoC until I have finished olofk/fusesoc#556