TAKING A FIRST LOOK AT THE JSYMBOLIC INSTALL

• The jSymbolic folder you just downloaded and unzipped holds the jSymbolic software, which you will be learning and working with
• The folders contained in the "jSymbolicTutorialWorkingFiles.zip" file you downloaded include various data, configuration, feature and other files that we will be working with soon
  • More about those later
• Open the jSymbolic folder you downloaded and unzipped
  • "jSymbolic2.jar" is the jSymbolic program
  • "lib" is a set of code libraries used by jSymbolic
    • You do not need to worry about these
  • jSymbolicDefaultConfigs.txt" contains the default settings jSymbolic starts with
    • e.g. features to extract, windowing settings, input files, output save paths, etc.
    • Later we will look at how to generate and use your own specialized jSymbolic configuration files
  • "README.md" is provides a basic introduction to jSymbolic
  • "manual" holds jSymbolic's detailed manual
• Open the "manual" sub-folder
  • Double click on the "home.html" file in this sub-folder to open the manual
  • Take particular note of the "Feature Explanations" section, which provides explanations on each of the features jSymbolic extracts
  • We will cover many important highlights in this tutorial, but the manual will provide an important reference for further details

RUNNING JSYMBOLIC BY DOUBLE CLICKING ON IT

• Go back to the main jSymbolic folder (the one that holds "jSymbolic2.jar"
• The easiest way to run jSymbolic is to just double click on "jSymbolic.jar", which will bring up the jSymbolic GUI
  • Try double clicking it
  • If Java is not installed on your computer, then this will not work
    • See the installation instructions we saw previously on how to install Java
  • If your computer asks you to authorize jSymbolic, or says that you do not have permission to run it, then authorize it
    • See the installation instructions for details on how to do this

RUNNING JSYMBOLIC FROM THE TERMINAL / COMMAND LINE

• Although double clicking on the jSymbolic2.jar file is almost always a perfectly fine way to start jSymbolic, this method of running jSymbolic may in rare occasions cause problems
  • Since Java may not allocate enough memory for it process very large files
• Let's try running jSymbolic a different way, just to be safe
  • Although, as noted above, it is usually absolutely fine to run it simply by double clicking it
• If jSymbolic is still open from the steps above, close it by pressing the exit box at the top right of the jSymbolic window
• We will now run jSymbolic from the command line
  • This allows us to instruct Java to give jSymbolic more memory if it needs it
  • It is also possible to use jSymbolic's dedicated command line interface (as opposed to its graphical user interface, which this tutorial focuses on), which can be a faster way of using the software once you get used to it
    • See the manual for more details on this way of using jSymbolic
• Open a text terminal on your computer and move to the jSymbolic directory in it:
  • Windows:
    • Press the windows button to allow you to open the search interface
    • Type "cmd" and press enter to spawn a terminal window
    • Type "cd the_path_of_the_jSymbolic_folder_you_downloaded_that_contains_the_jSymbolic2.jar_file" in the terminal and press enter to move to this folder
    • Type "dir" to see the files that are there and to make sure you are in the right place
  • Macintosh:
    • Press command-spacebar to allow you to open the search interface
    • Type "terminal" and press enter to spawn run a terminal window
    • Type "cd the_path_of_the_jSymbolic_folder_you_downloaded_that_contains_the_jSymbolic2.jar_file" in the terminal and press enter to move to this folder
    • Type "ls" to see the files that are there and to make sure you are in the right place
• Run the jSymbolic GUI in this terminal window (making sure that you moved into the jSymbolic folder you downloaded (the one containing "jSymbolic2.jar") in the terminal, as described above)
  • Type "java -Xmx6g -jar jSymbolic2.jar" to run jSymbolic
  • You will see the same jSymbolic window as you did before when you double clicked on "jSymbolic2.jar", but you have now given Java permission to assign jSymbolic much more memory if it needs it
• Leave this window open for the next steps

Congratulations, you have now got most of the infrastructural set-up work done. Now let's dive into actually using jSymbolic . . .

-top of page-