Installing on Windows#

Prerequisites#

  • Install Git for Windows. Make sure you download the version (either 32-bit or 64-bit) that matches your system (most likely 64 bit)

  • Install Python 3.11

    • Make sure you install the version (either 32-bit or 64-bit) that matches your system (most likely 64-bit)

    • In the install wizard, make sure you check the box that adds Python to your PATH

  • AWS access keys (optional)

    • Only needed if you intend to download firmware files. If you already have a local file to flash, you do not need access keys

    • These keys must be stored in ~/.aws/credentials as described here

Note

Make sure you download the 64-bit version if you downloaded the 64-bit Git above and the 32-bit version if you installed the 32-bit Git above.

Note

When going through the installation wizard, make sure you check the box that adds Python to your PATH.

Install bootloader in a virtual environment. From your Git Bash terminal:

mkdir -p ~/.venvs
python -m venv ~/.venvs/dephy
source ~/.venvs/dephy/Scripts/activate

You will need to run the above source command each time you open a new terminal unless you add the command to your profile.

Installing#

bootloader is installed via pip:

python -m pip install bootloader

Developing#

To develop bootloader, we strongly recommend installing Poetry.

To do so, start Windows Powershell as Administrator. By default, Powershell will not start in the same directory as Git Bash. This means in order to activate your virtual environment from Powershell, we have to first navigate to that directory. Here we use USER in place of your user name:

cd C:\Users\USER\.venvs\dephy\Scripts
.\Activate.ps1
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -

Note

Once installed, poetry should be available from your Git Bash terminal.

Activate the development environment and install the dependencies for bootloader by running the following commands from your Git Bash terminal and the bootloader repository:

poetry shell
poetry install

Pull Requests and Bug Reports (Issues) are welcome!