Configuration File

The Configuration file is passed as an argument to the firefly application and is the first code that is run. The main purpose of the configuration file is to specify the location of the hdf5 data files and loader script. It can be also used to initialize global variables.

The purpose of this file is to provide instructions on how to specify the hdf5 file path, as well as list all other global variables that can be initialized at this point.

Required Variables

Selecting Snapshots to load

This initialize the global variable datasetPath which will then be loaded in the loader.py script. The loader can accept multiple file paths seperated by the ';' character. If the hdf5 data comes in multiple files, it is recommended to modify the variable dataBase, otherwise, you can set the variable DatasetPath directly.

datasetBase = string Modify this variable to take a string that has the location of the snapshot files. The file should be a single directory that all relevant hdf5 files are located.

snapshotNumber = int A single integer that specifies the snapshot in the datasetBase. The snapshotNumber should be in the title of the file.

Other required variables

pointCloudLoadOptions = string: The loader options string should be in the format: "50000 0:100000:X", where X is the decimation level for the loader. The true decimation level is the product of the loader decimation level and the display decimation level. Higher decimation levels result in fewer points being loaded.

dqDec = int Sets the dynamic quality rendering mode. Higher number = faster rendering but lower quality

loaderScript = string This is a string depicting a path leading to a script of the Loader File.

Optional Variables

Camera Variables

pivotPosition = Vector(float x, float y, float z): sets the initial pivot point that the galaxy model will rotate around upon starting the application

cameraPosition = Vector(float x, float y, float z): Sets the initial camera position upon starting the application.

cameraOrientation = Quaternion.new_rotate_axis(float w, float ix, float iy, float iz) Determines the initial camera orientation when starting the application. The global variable must be assigned to an omegalib Quaternion object, with w representing the real component and ix, iy, and iz representing the imaginary components of each axis.

OrientOnCoM = boolean: OrientOnCoM: boolean. If set to true, will start with the camera pointed at the center of mass by default. The initial pivotPoint will also be set to the centerOfMass. If set to true, this OVERRIDES the default cameraOrientation and pivotPoint Variables.

Display variables

scale = float: Scales the entire 3d Dataset model. Useful if the dataset is too large or spread apart. This can simplify navigation.

Variable Paths

loaderScript= string Specifies the absolute path of the loader file. For more information, check the 'Loader File' page.

imagePath = string Set to a string, it will specify the destination path that screenshots taken will be saved to. Screenshots can be taken from the Javascript interface under the Views panel, and will be saved as a PNG screenshot of the entire screen.

presetPath = string Set to a string, it will specify the destination path that the presets will be loaded and saved to.