Skip to content

Latest commit

 

History

History
50 lines (41 loc) · 1.87 KB

basic_usage.md

File metadata and controls

50 lines (41 loc) · 1.87 KB

Basic Usage

This section will provide a guide on the basic usage of FortranAS for running with a locally installed JRE and with the provided Docker runtime context.

Running FortranAS

Grab the latest release: https://github.com/akoerner/FortranAS/releases

Prerequisites

The following prerequisites must be installed in order to run FortranAS:

  • Install JRE 19+
  • Install GraphViz (for DOT file conversion to SVG and PNG)
  • Install unifdef command line tool
  • Install python3 for Code Clone Analysis 🔗
  • Install meld for clone pair diffing

Usage

  1. Install all prerequisites
  2. Copy FORTRAN source code to ./source and optionally strip preprocessor directives using tools/unifdef.sh
  3. Run FortranAS:
./fortranas --output-directory output \
            --input-source-code-directory source \
            --print-fortran-files \
            --parse-fortran-files \
            --calculate-code-clones

ℹ️INFO: All FortranAS parsed and generated output files will be placed in ./output

  1. Run the Code Clone Analysis 🔗 scripts to generate and analyze code clone pairs.

Running FortranAS With Docker

  1. Follow the Quickstart 🔗 to setup FortranAS
  2. Place FORTRAN source code in ./source to parse and analyze it
  1. Run the provided FortranAS docker context via make:
make run

ℹ️INFO: All FortranAS parsed and generated output files will be placed in ./output

  1. Run the Code Clone Analysis 🔗 scripts to generate and analyze code clone pairs.