SetupAndUse.md

IDEAL Setup and Use

Note: The following steps have been verified on a Windows 10 operating system.

A. Prerequisites

B. Setup IDEAL

C. Configure and Run IDEAL For Project

Prerequisites

1. Install Git
2. Install Java JDK
3. Install Python 3.7.1
4. Install srcML 1.0.0
5. Download Stanford JARs 4.2.0
6. Clone/Download IDEAL repository 1.0.0

Setup IDEAL

1. Install virtual environment: py -m pip install --user virtualenv

   

2. Create virtual environment: py -m venv venv

   

3. Activate virtual environment: .\venv\Scripts\activate

   

4. Install packages from requirements files: py -m pip install -r requirements.txt

   

5. Download NLTK data. Enter the following commands:

   1. python
   2. import nltk
   3. nltk.download('wordnet')
   4. nltk.download('punkt')
   5. quit()
   

6. Update all paths in config file: src\common\config.txt

   

Configure and Run IDEAL For Project

1. Update all paths in the run command file: src\apps\IDEAL\run.cmd

   

2. Update all paths in the project config file: src\apps\IDEAL\project1.config

   

3. Create input.csv file and add paths to the source code files/directories

   

4. Run the run.cmd file

   

5. Results saved in IDEAL_Results.csv file

   

Back To ReadMe