From 8a6734c38df7f9b5a095d1306d7f0292baf0e56a Mon Sep 17 00:00:00 2001 From: Andreas Katis Date: Tue, 4 Oct 2022 20:53:13 -0400 Subject: [PATCH] Pushed documentation updates for realizability checking interface. --- fret-electron/docs/_media/exports/realizability.md | 14 +++++++++++++- .../docs/_media/exports/realizabilityManual.md | 12 ++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/fret-electron/docs/_media/exports/realizability.md b/fret-electron/docs/_media/exports/realizability.md index 6b0749b4..02fd98cf 100644 --- a/fret-electron/docs/_media/exports/realizability.md +++ b/fret-electron/docs/_media/exports/realizability.md @@ -123,4 +123,16 @@ The requirements table is also updated when a conflict is selected. The particip      -![](ChordDiagramRequirements2.png) \ No newline at end of file +![](ChordDiagramRequirements2.png) + +## Selecting requirements for realizability checking + +Users can select which requirements in a given system component should be considered for the purposes of analysis, allowing thus realizability checking and diagnosis for subset requirements. + +After selecting a system component, can users deselect requirements by clicking on their corresponding row in the requirements table. After the new set of requirements has been identified, click on the "Apply" button to confirm the selection. The interface is updated, considering the new set of requirements. This may lead to new results with respect to connected components analysis. All previous analysis results are cleared, and analysis can be performed for the new set using the steps outlined in the previous section. + +## Saving and loading realizability checking results + +FRET provides means to save a report containing the current results of a given analysis, including a) connected component analysis, b) realizability results and c) diagnostic results. Reports are currently saved using the JSON format. To save a report for a given project, click on "Actions" -> "Save realizability results". In the new window, select a path in your system to save the report in. Provide a name for the report and click on "Save". + +Users are also able to load saved reports and inspect them in FRET. Loaded reports are not associated with existing projects in the database. In other words, reports can be loaded even though the original project is not part of the FRET database. To load a report, click on the "Projects" button and select "All Projects". Then, navigate to the realizability tab in the Analysis Portal, and click on the "Load" button. In the new window, select the report to be loaded and click on "Load". The report should now be accessible using the graphical interface. \ No newline at end of file diff --git a/fret-electron/docs/_media/exports/realizabilityManual.md b/fret-electron/docs/_media/exports/realizabilityManual.md index f24374fc..5f9831a6 100644 --- a/fret-electron/docs/_media/exports/realizabilityManual.md +++ b/fret-electron/docs/_media/exports/realizabilityManual.md @@ -127,4 +127,16 @@ The requirements table is also updated when a conflict is selected. The particip      +## Selecting requirements for realizability checking + +Users can select which requirements in a given system component should be considered for the purposes of analysis, allowing thus realizability checking and diagnosis for subset requirements. + +After selecting a system component, users can deselect requirements by clicking on their corresponding row in the requirements table. After the new set of requirements has been identified, click on the "Apply" button to confirm the selection. The interface is updated, considering the new set of requirements. This may lead to new results with respect to connected components analysis. All previous analysis results are cleared, and analysis can be performed for the new set using the steps outlined in the previous section. + +## Saving and loading realizability checking results + +FRET provides means to save a report containing the current results of a given analysis, including a) connected component analysis, b) realizability results and c) diagnostic results. Reports are currently saved using the JSON format. To save a report for a given project, click on "Actions" -> "Save realizability results". In the new window, select a path in your system to save the report in. Provide a name for the report and click on "Save". + +Users are also able to load saved reports and inspect them in FRET. Loaded reports are not associated with existing projects in the database. In other words, reports can be loaded even though the original project is not part of the FRET database. To load a report, click on the "Projects" button and select "All Projects". Then, navigate to the realizability tab in the Analysis Portal, and click on the "Load" button. In the new window, select the report to be loaded and click on "Load". The report should now be accessible using the graphical interface. + [Back to FRET home page](../userManual.md) \ No newline at end of file