cbmeeks/apio

:seedling: Open source ecosystem for open FPGA boards

       

Open source ecosystem for open FPGA boards. It was inspired by PlatformIO.

Apio (pronounced [ˈa.pjo]) is a multiplatform toolbox, with static pre-built packages, project configuration tools and easy command interface to verify, synthesize, simulate and upload your verilog designs.

Apio is used by Icestudio.

Table of contents

• Installation
• Apio packages
• Supported boards
• Documentation
• Development
• Videos
• Authors
• Contributors
• License

Installation

1. Install Python and pip

2. Install the latest apio: pip install -U apio

Apio packages

Package	Installation	Description
drivers	apio install drivers	Drivers tools (only for Windows)
examples	apio install examples	Verilog basic examples, pinouts, etc
gtkwave	apio install gtkwave	Simulation viewer. GTKWave project (only for Windows)
icestorm	apio install icestorm	iCE40 FPGA synthesis, place & route and configuration tools. Icestorm project
iverilog	apio install iverilog	Verilog simulation and synthesis tool. Icarus Verilog project
scons	apio install scons	A software construction tool. Scons project
system	apio install system	Tools for listing the USB devices and retrieving information from the FTDI chips
verilator	apio install verilator	Verilog HDL simulator. Verilator project

Supported platforms

linux_x86_64, linux_i686, linux_armv7l, linux_aarch64, windows_x86, windows_amd64, darwin.

Supported boards

HX1K

Board name	Interface
IceZUM Alhambra	FTDI
Nandland Go board	FTDI
iCEstick Evaluation Kit	FTDI
iCEblink40-HX1K	Digilent Adept

HX8K

Board name	Interface
Alhambra II	FTDI
BlackIce	Serial
BlackIce II	Serial
CAT Board	GPIO RPi
icoBOARD 1.0	GPIO RPi
Kéfir I iCE40-HX4K	FTDI
iCE40-HX8K Breakout Board	FTDI
Alchitry Cu	FTDI

LP8K

Board name	Interface
TinyFPGA B2	Serial
TinyFPGA BX	Serial

UP5K

Board name	Interface
UPDuino v1.0	FTDI
UPDuino v2.0	FTDI
iCEBreaker	FTDI
iCEBreaker bitsy	FTDI
FPGA 101 Workshop Badge Board	FTDI
iCE40 UltraPlus Breakout Board	FTDI
Fomu	FTDI

NOTE: all supported Icestorm FPGAs can be used with --fpga or --size, --type and --pack options.

Documentation

The complete documentation of the project can be found in Read the Docs: http://apiodoc.readthedocs.io. There is also a list of frequently asked questions (FAQ) that you can check here.

Development

git clone https://github.com/FPGAwars/apio.git
cd apio

Testing

pip install tox

tox

tox -e offline
tox -e coverage

Documentation

cd docs
make html
firefox _build/html/index.html

Debian packaging

Also you can find the debian scripts to package the full application and all the packages here: https://github.com/set-soft/apio-debian.

Thanks Salvador E. Tropea!

Videos

Authors

• Jesús Arroyo Torrens
• Juan González (Obijuan)

Contributors

• Salvador E. Tropea
• Miguel Sánchez de León Peque
• devbisme
• Miodrag Milanovic

Credits

• FPGAwars community has developed this project in a voluntary and altruistic way since 11/2016.

  

• BQ sponsored this project from 02/2016 to 11/2016. Thanks.

License

Licensed under GPL 2.0 and Creative Commons Attribution-ShareAlike 4.0 International License.