README.md
F´ (F Prime) is a component-driven framework that enables rapid development and deployment of spaceflight and other embedded software applications. Originally developed at the Jet Propulsion Laboratory, F´ has been successfully deployed on several space applications. It is tailored but not limited to small-scale spaceflight systems such as CubeSats, SmallSats, and instruments.
Please Visit the F´ Website: https://fprime.jpl.nasa.gov for more information.
Learn more about F´ key features.
The following system requirements apply to your workstation for developing F´ applications. To see the list of supported platforms on which F´ applications can run on, see Supported Platforms.
Linux, Windows with WSL, or macOS operating system
Clang or GNU C and C++ compilers (e.g. gcc and g++)
git --version
python --version and python -m venv -h. Your system might use an alternate like python3 or python3.13. For pip: pip --version. On your system it might be pip3 or pipx.
g++ --version and then create, build, and run a test program. For example, create a file named hello.cpp with contents:
#include <iostream>
int main(void){
std::cout << "Hello, World!" << std::endl;
}
then build and run it, for example like:
% g++ -o hi hello.cpp
% ./hi
Hello, World!
To get started with F´, install the F´ bootstrapping tool with:
pip install fprime-bootstrap
Then, create a new project with:
fprime-bootstrap project
See the HelloWorld Tutorial to guide you through all the steps of developing an F´ project.
New users are encouraged to read through the User Manual and explore the other tutorials.
To ask questions, discuss improvements, and ask for help please use the project's GitHub Discussions.
To report bugs and issues, open an issue here.
The F´ Community GitHub Organization contains third party contributions, more documentation of flight software development, and additional resources.
The following roles are members of the CCB and per our governance document have decision making power within the framework.
| Role | Team Member |
|---|---|
| Community Manager | @LeStarch |
| Community Manager | @thomas-bc |
| Community Manager | @kevin-f-ortega |
| Security Overseer | @bitWarrior |
| CCB Member | @bocchino |
| CCB Member | @kevin-f-ortega |
| CCB Member | @SterlingPeet |
| CCB Member | @timcanham |
| CCB Member | @zimri-leisher |
Each product has a set of Maintainers who are charged with the day-to-day implementation of the CCB's direction as realized in a by product.
| Product | Core Maintainer(s) |
|---|---|
| F Prime | @LeStarch, @thomas-bc |
| F Prime (v3.6.x Maintenance) | @SterlingPeet |
| fprime-tools | @thomas-bc, @LeStarch |
| fprime-gds | @thomas-bc, @LeStarch |
| fpp | @bocchino, @Kronos3 |
| F Prime Platforms | @kevin-f-ortega, @LeStarch |
| Security | @bitWarrior |
The version history and artifacts associated with the project can be found at Releases.