Skip to content

Third Party Tools Setup

Jump to bottom
Carlos Paradis edited this page Feb 2, 2024 · 2 revisions

See DESCRIPTION for the libraries used and package versions used by Kaiaulu.

Dependencies in this package are modular. Depending on what you seek, you may only need to setup a sub-set of this section. Each module is divided by subsection below. Minimally you need to:

The following is optional depending on the functionality you seek:

Gitlog analysis

  1. Create a py virtualenv (optional)
  2. pip3 install perceval==0.12.24 (using py virtualenv) or pip install perceval=0.12.24
  3. which perceval to get path of local installation and note this in tools.yml.
  4. Open vignettes/gitlog_showcase.Rmd or vignettes/churn_metrics.Rmd for examples and viz on gitlog analysis.

Mailing List Analysis

  1. Create a py virtualenv (optional)
  2. pip3 install perceval=0.12.24 (using py virtualenv) or pip install perceval=0.12.24
  3. which perceval to get path of local installation and note this in tools.yml.
  4. Open vignettes/mailinglist_showcase.Rmd for examples and viz on mailing list analysis.

Dependency Analysis

  1. Download Depends release (last tested on 0.96a)
  2. Open the Depends folder, and note the depends.jar path in tools.yml.
  3. See vignettes/depends_showcase.Rmd for examples and viz on file dependency analysis.

Lines of Code, Comments, etc

  1. Download scc (last tested on 2.12.0)
  2. Unzip to obtain a scc executable. Note its path in tools.yml
  3. See vignettes/line_metrics_showcase.Rmd for examples.

Line types

  1. Download Universal ctags using brew.
  2. Emacs ctags may conflict with brew ctags. If so, using ctags may call emacs ctags instead of universal ctags from brew. Locate the binary of brew ctags and note its path on tools.yml
  3. See vignettes/line_type_showcase.Rmd for usage.

Refactoring Code Analysis (Java only)

  1. Download or clone most recent version of Refactoring Miner
  2. cd to Refactoring Miner folder and type ./gradlew distZip
  3. Extract the file under build/distribution/RefactoringMiner.zip in the desired location
  4. In the extracted folder, locate /bin/RefactoringMiner, and note its path on Kaiaulu tools.yml.
  5. See vignettes/refactoringminer_showcase.Rmd for details.

OSLOM Community Detection

  1. Download OSLOM code (last tested on beta version 2.4)
  2. Use ./compile_all.sh, as the manual suggests, to obtain ./oslom_undir and /oslom_dir, and note its path on Kaiaulu tools.yml. See vignettes/community_detection_showcase.Rmd for details.
Clone this wiki locally