FRET: Formal Requirements Elicitation Tool

Introduction

FRET is a framework for the elicitation, formalization and understanding of requirements. Users enter system requirements in a specialized natural language. FRET helps understanding and review of semantics by utilizing a variety of forms for each requirement: natural language description, formal mathematical logics, and diagrams. Requirements can be defined in a hierarchical fashion and can be exported in a variety of forms to be used by analysis tools.

Take a look at the FRET demo.

Contact

Please contact fret@lists.nasa.gov for further information on FRET. Detailed information can be found at the FRET manual.

Installation

Dependencies

nodejs [recommended v10.15.x]
Python 2.x
(Optional) NuSMV

Download and Install

As you open the FRET distribution, you shall see the following directory structure:

.
├── fret-electron
├── tools
├── README.md
└── LICENSE.pdf

Here are the steps to install and start FRET:

cd fret-electron
npm install ../tools/LTLSIM/ltlsim-core
npm install
npm start

It's as simple as that. Enjoy!

Notes

Note: To run the LTLSIM simulator, a NuSMV (see http://nusmv.fbk.eu/) installation is required. Please make sure that the NuSMV binaries directory is added to the PATH environment variable. Additionally, please add $PATH_TO_FRET/fret/tools/LTLSIM/ltlsim-core/simulator to the PATH environment variable.

Note: FRET requires python 2.x. If your machine is running a newer version of python, e.g., 3.x, then please config FRET to search for a python2 executable. Run the following: npm config set python /usr/bin/python2.x

Note: Compiling on Windows machines requires gcc and the node-gyp prerequisites.

Note: If you would like to upgrade your nodejs version (and you have been using FRET before), please first remove node_modules under fret-electron/ and fret-electron/app/ and then do steps 2-4.

Note: Recommended npm version 6.x (comes with nodejs v10.x)

Platforms

FRET has been tested in a range of architecture/operating system combinations. It has been tested on PC Intel, Apple Mac and Sun architectures, with different versions and distributions of Linux, Windows and Mac OS X.

License

FRET has been released under the NASA Open Source Agreement version 1.3, see LICENSE.pdf.

Contributors

See the FRET Contributors.

hbourbouh / fret