Installation and usage

Installation

fp2p is not available on the PyPI website. Why? fp2p is pure program, contained within single file, there is no library part, it can’t be imported. This will never change. What is more, I didn’t want to litter PyPI with a program that is relatively rarely used (although being very useful). It is not like new boards are designed or manufactured once per week or month.

User has full freedom in terms of installation. For example, you can do one of the followings:

Copy fp2p.py file to the repository with the FPGA project design.
Add fp2p repository as a submodule to the repository with the FPGA project design.
Clone the repository somewhere in the filesystem and call the program providing path python ~/your/path/fp2p/fp2p.py ....
Copy fp2p.py file to some directory included in the PATH. You may want to add shebang to the file, for example #!/bin/python and chmod +x fp2p.py.

Usage

fp2p supports 3 subcommands:

assign - assings ports to pins,
graph - resolves a mapping tree and prints graph,
resolve - resolves a mapping tree and prints the result.

After preparing proper mapping tree files or assignment files user only needs to call fp2p with one of the subcommands and proper order of arguments. This is further explained in the section Subcommands. You can also always run python fp2p.py -h or python fp2p.py {subcommand} -h.

Windows

The program has not been tested on Windows OS, and no one has so far reported that it works corretly. However, it should work, as no OS specific mechanisms or system calls are used.