The executable for the Colosssus GUI can be found on the releases page as a .jar file. Download the latest release and place the executable .jar file in whichever folder the DAQ data files will be written to.
The GUI requires having at least JRE 1.8 installed; the download that can be found here.
After downloading and installing a compatible version of Java, the .jar can be run as a normal executable or through the terminal or command prompt via the following command:
~$ java -jar <filename>
This repository uses Git for version control and GitHub for hosting.
- Download and install Git.
- Clone the repository:
git clone https://github.com/Rtmurase/SFS-Colossus.
This repository is written in Java and uses Gradle for dependency management and build automation.
- Download and install the latest version of the JDK—not the JRE.
- Download and install Gradle.
- Navigate to the main directory (the one with
build.gradle). - Run the Gradle command to build the project (see the list of Gradle commands).
Once the project has been built, run it as an executable: java -jar build/libs/ColossusGUI.jar. NOTE: ColossusGUI.jar cannot be run from the build/libs/ directory since it pulls the DAQ data from files in the working directory.
To test if the GUI works, there's a simulation available within src/test that randomly generates data files for the GUI to read in as if they were from the DAQ itself. Note: the entire project must be built (see the section on Gradle commands) before the simulation can be run. After building, run the following commands in a separate terminal:
~$ cd build/classes/java/test
~$ java sim.randomThe sim.random process will be running through the other terminal now, so the original terminal can be used to run the GUI as an executable JAR (as outlined above):
~$ java -jar build/libs/ColossusGUI.jarTo stop running the simulations, interrupt both the sim.random and GUI processes via CTRL-C.
Deletes the build directory.
Assembles the project. Bound to the custom shadowJar, handleDependencies, and rmtmp tasks. shadowJar assembles a "fat" or "uber" JAR, which is basically just a JAR that contains the compiled bytecode (project class files) and resources packed together with all the project dependencies. handleDependencies pulls dependencies from the central Maven repository and copies them over to libs/. rmtmp removes the build/tmp/ directory since it only contains manifests from other internal tasks.
Cleans up after the ColossusGUI post-execution. Right now, deletes the MARCO1 files the GUI generates and the various test files randomIn generates.
These commands can all be chained together as well (e.g. gradle clean build).