Initial Project Setup

This guide will walk through the steps of setting up the reference deployment.

1. Clone the GitHub repository

Clone the GitHub repository onto your local machine.

git clone https://github.com/Open-Source-Space-Foundation/proves-core-reference.git

Note

If you would like to use fprime-bootstrap instead of git to clone this project, run this command and skip to step 5.

fprime-bootstrap clone https://github.com/Open-Source-Space-Foundation/proves-core-reference.git

2. Fetch git submodules

Install the required libraries for this deployment

# In proves-core-reference
git submodule update --recursive --init

3. Create a virtual environment

Create a virtual environment in the main project directory

# In proves-core-reference
python3 -m venv fprime-venv

4. Activate the virtual environment

# In proves-core-reference
# Linux, MacOS, & Windows WSL
source fprime-venv/bin/activate

5. Install python requirements

With the virtual environment activated, install the requirements

# In proves-core-reference (fprime-venv)
pip install -r requirements.txt

Note

You will need to follow some additional steps if you are using a different board than the one specified in the settings.ini file. Please refer to the Specifying Board Configuration documentation for more information.

6. Get Zephyr Source Code

Navigate to the zephyr-workspace directory to set up zephyr. You may need to update the config file in ./lib/zephyr-workspace/.west/ if you are using a different board. Refer to the documentation here

# In proves-core-reference
cd lib/zephyr-workspace

# Run the following commands
west update
west zephyr-export

Note

If you have not installed the Zephyr SDK, please install it with the following command:

# In proves-core-reference/lib/zephyr-workspace/zephyr
west sdk install

The Zephyr SDK only needs to be installed once.

Next Steps: Building, Flashing, and Running the Deployment