From 2ab6d9d5450211318662981031a623b1b0951bfb Mon Sep 17 00:00:00 2001 From: Cel Skeggs Date: Tue, 21 Apr 2026 08:27:13 -0700 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4dee8ad..0ff4179 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,24 @@ F Prime Python Model is a utility for translating `fpp-to-json` AST, Location Ma and Analysis JSON to Python data structures. For more information on the `fpp-to-json` tool, see the [FPP User's Guide](https://nasa.github.io/fpp/fpp-users-guide.html#Analyzing-and-Translating-Models_Generating-JSON-Models). - ## Installation ```sh -git clone https://github.com/fprime-community/fprime-python-model.git -cd fprime-python-model -pip install . +pip install git+https://github.com/fprime-community/fprime-python-model.git ``` ## Usage In order to use this utility, you must first run the `fpp-to-json` tool to generate -the AST, Location Map, and Analysis JSON files for a given FPP model. For specific -steps on how to run `fpp-to-json`, see the -[FPP User's Guide](https://nasa.github.io/fpp/fpp-users-guide.html#Analyzing-and-Translating-Models_Generating-JSON-Models). +the AST, Location Map, and Analysis JSON files for a given FPP model. + +* When using `fpp-to-json` as part of a larger project, you can set + `FPRIME_ENABLE_JSON_MODEL_GENERATION=ON` in your settings.ini to generate JSON + files automatically. +* For specific steps on how to run `fpp-to-json` manually, see the + [FPP User's Guide](https://nasa.github.io/fpp/fpp-users-guide.html#Analyzing-and-Translating-Models_Generating-JSON-Models). -> Note: When running the `fpp-to-json` tool, ensure that you *do not* include the -> `-s` option as that will prevent the Analysis JSON from being generated. + > Note: When running the `fpp-to-json` tool, ensure that you *do not* include the + > `-s` option as that will prevent the Analysis JSON from being generated. Once the AST, Location Map, and Analysis JSON files have been generated, you can translate the model JSON to it's Python representation by doing: @@ -40,7 +41,7 @@ the FPP AST, Location Map, and Analysis of the model: ```python model.ast # Model AST -model.locations # Location map +model.location_map # Location map model.analysis # Model Analysis data structure ```