Make sure the program directory is set up as described in Installation. There is a GUI and non-GUI command line mode to run the program. Either mode can be started from the terminal/command prompt. The Bubble_Index.jar executable must be located in the same directory as the ProgramData and lib folders.

GUI Mode

The GUI Mode can be started by simply double clicking the Bubble_Index.jar executable jar.

To start from command, enter:

java -jar Bubble_Index.jar

command while in the folder containing the Bubble_Index.jar executable. Or Issue:

java -jar /dir_path/Bubble_Index.jar

To get started with The Bubble Index, the daily data must be downloaded or updated. This is all done automatically by clicking the Update All button.

When updating non-American stocks (such as Brazil, India, etc...) with the Update All button, MAKE SURE TO DELETE ALL PREVIOUS DAILY DATA CSV FILES before the update. (NOTE: with recent releases, manual deletion is not necessary because the program automatically performs the delete) If not, you will get situations where the daily data repeats itself numerous times. You can do this easily in Linux by issuing the following command while in the ProgramData folder:

find . -type f -name '*dailydata.csv' -delete

Once the data has been updated, there are two ways to proceed: calculate a single time series or calculate the values for all the times series listed in the drop down category. Select the Plot Graph check box if a graph is desired. When plotting, you may specify the Beginning and End Dates via the GUI.

1. Set Model Parameters

Enter the desired model parameters for Omega, M, and T_critical. The default values are the values which are used for the website indices. These parameters are found in the LPPL Oscillation model equation: http://arxiv.org/abs/cond-mat/0201458. Enter the length of data (windows) with which to run the calculations. This is a comma separated list. Ex. 52, 104, 153, 256, 512

2. Run a Single Time Series

Choose the desired time series from the drop down selection boxes. Adjust the model window lengths if desired. Click Run. Wait for the program to calculate the values. If this is the first run, it may take several hours depending on the hardware available. After completion, the GUI will say "Done." If the Plot Graph check box was selected, a two windows should appear. One contains The Bubble Index values plotted with the daily values. The other is a graph of the derivatives. (Warning: Times series with dates before 1900 will NOT plot)

3. Run All Names

Choose the desired category. Click the Run All Names button. The program will Run through all the indices in the category type.

4. Run All Types

Click the Run All Types button. The program will Run through all the types in every category.

The Stop button may be used to stop the calculation of a single time series.

The Exit button closing the program.

Non-GUI Command Line Mode

1. Open a terminal or command prompt. Navigate to the directory of installation.

2. Issue the appropriate command:

java -jar Bubble_Index.jar noGUI RunType Category Selection Windows Threads T_Crit M Omega ForceCPU

NOTE: Selection only applies if RunType=Single; Selection and Category do not apply if RunType=All

Examples:

Run all entries in the Currencies category, 100 threads with CPU:
java -jar Bubble_Index.jar noGUI Category Currencies 3000,3200,3500,3700,4000 100 21.0 0.38 6.28 true

Run BITSTAMPUSD with 4 threads, GPU:
java -jar Bubble_Index.jar noGUI Single Currencies BITSTAMPUSD 153,256 4 21.0 0.38 6.28 false

Run All categories and all entries with 4 threads and CPU:
java -jar Bubble_Index.jar noGUI All 512,1260 4 21.0 0.38 6.28 true

Update data:
java -jar Bubble_Index.jar noGUI Update

Update data with a specified Quandl API key:
java -jar Bubble_Index.jar noGUI Update QuANdLkEy

Last edited Aug 13, 2015 at 7:17 PM by ttrott, version 22