Differences

This shows you the differences between two versions of the page.

--- sift:tutorials:command_line [2024/09/25 14:51] – sgranger
+++ sift:tutorials:command_line [2025/02/06 16:33] (current) – sgranger
@@ Line 1: / Line 1: @@
 ======Batch Command Line Processing Tutorial======
-In this tutorial, we will guide you through running Sift on the command line. You'll learn how to load a library, execute queries, run PCA (Principal Component Analysis), and use it for outlier detection. After walking through each command step by step, we’ll create a batch script to automate these tasks. We'll also include some logic to further streamline the process. To get started, download the sample data folder. {{automation_tutorial.zip}}
+In this tutorial, we will guide you through running Sift on the command line. You'll learn how to load a library, execute queries, run PCA (Principal Component Analysis), and use it for outlier detection. After walking through each command step by step, we’ll create a batch script to automate these tasks. We'll also include some logic to further streamline the process. To get started, download the sample data folder. {{:automation_tutorial.zip}}
 =====Running on Command Line=====
   - First, we need to run Sift via the command line. On your keyboard, press Windows Key + R, type "cmd" into the run window, and press Enter to open a command prompt. \\ {{:windows_run_dialog.png}}
   - Next, navigate to Sift's installation directory. \\ {{:change_directory.png}}
-  - To launch Sift, call the .exe file and pass the --NoGUI argument \\ {{:launch_sift.png}}
+  - To launch Sift, call the .exe file and pass the -NoGUI argument \\ {{:launch_sift.png}}
   - This will open new console where we can interact with Sift
-  - In this console, load a library by entering the command: //--LoadLib directory "**Path to downloaded library**"// \\ {{:cl_load_lib.png}}
+  - In this console, load a library by entering the command: //-LoadLib directory "**Path to downloaded library**"// \\ {{:cl_load_lib.png}}
-  - Next load and run a predefined query by entering: //--LoadQuery file "**Path to query definition file**"// \\ {{:cl_load_query.png}}
+  - Next load and run a predefined query by entering: //-LoadQuery file "**Path to query definition file**"// \\ {{:cl_load_query.png}}
-  - Select all signals by running //--SelectSignals// (Ensure all signal groups and work-spaces have been selected) \\ {{:cl_select_signals.png}}
+  - Select all signals by running //-SelectSignals// (Ensure all signal groups and work-spaces have been selected) \\ {{:cl_select_signals.png}}
-  - Run a PCA named "Outlier_PCA" //--RunPCA name "Outlier_PCA"// \\ {{:cl_run_pca.png}}
+  - Run a PCA named "Outlier_PCA" //-RunPCA name "Outlier_PCA"// \\ {{:cl_run_pca.png}}
-  - Now, let's perform the first round of outlier detection. Run a Local Outlier Factor (LOF) test with the command: //--RunLOF grouping "group" autoExclude// This will find any group level outliers and exclude them automatically \\ {{:cl_lof_one.png}}
+  - Now, let's perform the first round of outlier detection. Run a Local Outlier Factor (LOF) test with the command: //-RunLOF grouping "group" autoExclude// This will find any group level outliers and exclude them automatically \\ {{:cl_lof_one.png}}
-  - To export the results of this LOF test, run: //--ExportPCA file "Path to exported txt file" exportFormat "transposed" LOF LOFThrehsold// \\ {{:cl_export_group_outliers.png}}
+  - To export the results of this LOF test, run: //-ExportPCA file "Path to exported txt file" exportFormat "transposed" LOF LOFThrehsold// \\ {{:cl_export_group_outliers.png}}
-  - Next, run another LOF test, this time on workspaces: //--RunLOF grouping "workspace" autoExclude// \\ {{:cl_lof_workspace.png}}
+  - Next, run another LOF test, this time on workspaces: //-RunLOF grouping "workspace" autoExclude// \\ {{:cl_lof_workspace.png}}
-  - Export the results of this LOF test as well: //--ExportPCA file "Path to exported txt file" exportFormat "transposed" LOF LOFThreshold// \\ {{:cl_export_workspace_outliers.png}}
+  - Export the results of this LOF test as well: //-ExportPCA file "Path to exported txt file" exportFormat "transposed" LOF LOFThreshold// \\ {{:cl_export_workspace_outliers.png}}
-  - Finally, save the project to allow for future review in the GUI, if needed: //--SaveProject file "Path to saved project"// \\ {{:cl_save_project.png}}
+  - Finally, save the project to allow for future review in the GUI, if needed: //-SaveProject file "Path to saved project"// \\ {{:cl_save_project.png}}
 Now that processing is complete, we have two exports detailing group and workspace-level outliers, along with a saved project file that excludes all detected outliers. This can serve as a baseline for future processing.
@@ Line 56: / Line 56: @@
         :: Run Sift with the necessary commands to process the data
-        "C:\Program Files (x86)\Sift\Sift.exe" --NoGui --LoadLib directory "%%d" --LoadQuery file "%%d\query_definition.q3d" --selectSignals --RunPCA name "Outlier_PCA" --RunLOF grouping "group" autoExclude --ExportPCA file "%%d\Group Outliers.txt" exportFormat "transposed" lof lofThreshold --RunLOF grouping "workspace" autoExclude --ExportPCA file "%%d\Workspace Outliers.txt" exportFormat "transposed" lof lofThreshold --SaveProject file "%%d\Outliers.i3d" --Exit
+        "C:\Program Files\Sift\Sift.exe" -NoGui -LoadLib directory "%%d" -LoadQuery file "%%d\query_definition.q3d" -selectSignals -RunPCA name "Outlier_PCA" -RunLOF grouping "group" autoExclude -ExportPCA file "%%d\Group Outliers.txt" exportFormat "transposed" lof lofThreshold -RunLOF grouping "workspace" autoExclude -ExportPCA file "%%d\Workspace Outliers.txt" exportFormat "transposed" lof lofThreshold -SaveProject file "%%d\Outliers.i3d" -Exit
     )
 )