Instructions for Compiling and Running SPMF

Compiling the source code of SPMF is easy since it has no dependencies to other Java project.

Below, I provide a simple guide about how to compile the code of SPMF using three popular development environment: Eclipse, Netbeans and IntelliJ.

Compiling the source code with Eclipse

How to import the source code in Eclipse, and compile the project:

  1. Install Eclipse. Make sure that you have installed the latest version of the JAVA SDK on your machine.
  2. Open Eclipse. Do "File / New / Java Project /"
  3. Type the name of the project and then click on "Finish"
  4. Then, right-click on the "src" folder of the Java project that you have created. Choose "Properties". Copy the name of the directory that is shown in the properties. It should be something like that: "C:\eclipse\Workspace\test2\src"
  5. Go to that directory. Download the file spmf.zip (if you have not done it yet) and uncompress it there so that the folder "ca" should appear directly in the folder "src".
  6. Go back into Eclipse.
  7. Right-click on! the Java project and select "Refresh".
  8. This is it. The project is now installed.

How to run the test files:

Once you have installed the project you are ready for running the
software.

  1. In Eclipse, you should go to "ca.pfv.spmf.test" folder, in your Java project. In this folder there are all the examples of how to use the software. All of these examples are described on the website : ( https://www.philippe-fournier-viger.com/spmf/ )
  2. Let say that you want to run the CHARM algorithm. There is an example of how to run CHARM in the documentation of SPMF, which indicate that we should run the file ""MainTestCharm_bitset_saveToFile.java""
  3. To run it, you have to right click on MainTestCharm_bitset_saveToFile.java" and then choose "Run as / Java application".
  4. That's it! You can modify the test files to take other files as input or change the parameters of the algorithms.

Compiling the source code with NetBeans

How to import the source code in Netbeans, and compile the project:

  1. Install Netbeans. Make sure that you have installed the latest version of the JAVA SDK on your machine.
  2. Open NetBeans. Do "File" > New project > Java Application > Next >
  3. Type the name of the project and then click on "Finish"
  4. Then, right click on "Source packages" and go to "Properties". This will open a window showing the project path. The project path should be something like that: "C:\Users\ph\Documents\NetBeansProjects\JavaApplication1"
  5. Go to that directory. Download the file spmf.zip (if you have not done it yet) and uncompress it there so that the folder "ca" should appear directly in the folder "src".
  6. Go back into NetBeans.
  7. This is it. The project is now installed.

How to run the test files:

Once you have installed the project you are ready for running the software.

  1. In NetBeans, you should go to "ca.pfv.spmf.test" folder, in your Java project. In this folder there are all the examples of how to use the software. All of these examples are described in the documentation on the website : ( https://www.philippe-fournier-viger.com/spmf/ )
  2. Let say that you want to run the CHARM algorithm. There is an example of how to run CHARM in the documentation of SPMF, which indicate that we should run the file ""MainTestCharm_bitset_saveToFile.java""
  3. To run it, you have to right click on MainTestCharm_bitset_saveToFile.java" and then choose "Run file".
  4. That's it! You can modify the test files to take other files as input or change the parameters of the algorithms.

Compiling the source code with IntelliJ

How to import the source code in IntelliJ, and compile the project:

  1. Install IntelliJ. Make sure that you have installed the latest version of the JAVA SDK on your machine.
  2. Open IntelliJ.
  3. Click "New Project".
  4. Type the name of the project and then click on "Finish"
  5. Then, right click on the project and click on "Open In > Explorer ". This will open a window showing the directory for this project on your computer. The project path should be something like that: "C:\Users\phil\IdeaProjects\Name_of_project\"
  6. Download the file spmf.zip (if you have not done it yet) and uncompress it there so that the folder "ca" should appear directly in the folder "src".
  7. Go back into IntelliJ.
  8. This is it. The project is now installed.

How to run the test files:

Once you have installed the project you are ready for running the software.

  1. In IntelliJ, you should go to "ca.pfv.spmf.test" folder, in your Java project. In this folder there are all the examples of how to use the software. All of these examples are described in the documentation on the website : ( https://www.philippe-fournier-viger.com/spmf/ )
  2. Let say that you want to run the CHARM algorithm. There is an example of how to run CHARM in the documentation of SPMF, which indicate that we should run the file ""MainTestCharm_bitset_saveToFile.java""
  3. To run it, you have to right click on MainTestCharm_bitset_saveToFile.java" and then choose "Run MainTestCharm_bitset_saveToFile main()".
  4. That's it! You can modify the test files to take other files as input or change the parameters of the algorithms.