Tree View

The tree view of CPS contains quite a lot of directories. The aim of this section is to give a quick overview of what each one of them is for.

It is divided in two parts, each one being dedicated to one of the main folders: cps and data.

This folder contains the classical java tree-view:

• src

  This is where the source files (with the .java extension) are stored. Their content is detailed in a dedicated part of this website.

• doc

  This ones contains the Javadoc of CPS. This folder is classical for Java projects and it allows softwares like Eclipse to display it while you are coding.

• doxygen

  Contains all the data necessary for doxygen to work, i.e a configuration file, a script launching the creation of the documentation and a folder containing additional files, such as the header to use.

• lib

  This folder contains the external library used by CPS, for example jdom (used to parse and write xml files).

• bin

  At last, this folder contains the bytecode resulting from the compilation of the source files.

It also contains a script, cps.sh allowing UNIX-like users to avoid typing "java -cp 'bin/:lib/*' myShell.MainClass" every time they use CPS.

This is where useful data is stored, as well as a stub to allow easy testing and other scripts. First, let's take a look at the files stored here:

• config.xml

  More details on what this is used for here.

• media.xml

  More details on what this is used for here.

Now, here is a list of all the folders you will find here:

• HITdata

  CPS will write the csv files to upload to CrowdFlower here. You should not have to touch anything here.

• HITresults

  This is where CPS will write the results downloaded from CrowdFlower. The download, the extraction of the file and its renaming are performed in one operation.

• log

  No matter what the arguments specified are, CPS will create a log file here when you launch it. The name of the log files have the following structure, describing the time at which it was started: dd-mm-yyyy-(hh-mm-ss).log, where:

  • dd is the number of the day
  • The first mm is the number of the month
  • yyyy is the complete number of the year
  • hh is the hour
  • The second mm is the minute
  • ss is the second
  Note: Even if you are continuing an ongoing splitsort using the --iteration argument, a new log file will be created.

• previously

  In order to be able to start again where he left, CPS stores the intermediary results of the sort in this folder. Therefore, if a splitsort is running, it will contain a file for each axis studied. It also contains a tiny file simply containing the number of the job from where results should be retrieved.

• mysql

  This folder contains data used to interact with the MySQL database. The most important is the dump.sh script performing the dump of the database.