This repository has been archived on 2024-06-02. You can view files and clone it, but cannot push or open issues or pull requests.
upsilon-docker/environment_setup.md

45 lines
1.1 KiB
Markdown

MagLab Upsilon development environment setup.
Written by Peter McGoron.
Preqreuisites
=============
Rebinding Caps Lock to Escape
-----------------------------
gsettings set org.gnome.desktop.input-sources xkb-options "['caps:swapescape']"
Installing OpenFPGALoader
-------------------------
Then install [openFPGALoader][1]. This utility entered the Ubuntu repositories
in 23.04. Install and compile it if you do not have it. Install the udev rule
so that admin access is not required to load FPGA bitstreams.
[1]: https://trabucayre.github.io/openFPGALoader/index.html
Setup Rootless Docker
---------------------
Docker allows you to run programs in containers, which are isolated
environments. Upsilon development (at the Maglab) uses Docker for
reproducibility: the environment can be set up automatically, and re-setup
whenever needed.
If you have issues with docker, try adding to `~/.config/docker/daemon.json`
{
"storage-driver": "fuse-overlayfs"
}
Download and Install Python3
----------------------------
Install `python3-venv` (or `python3-virtualenv`) and `python3-pip`.
Setup Build Environment
=======================