.. _variables_setup: Variables ========== .. list-table:: List of Variables in Lucy. :header-rows: 1 * - Name - Type - Descriptions - Example * - SOLVER_TYPE - Specifies Type of Solver - Value specified must match to a corresponding solver with a matching binary and configuration in lucy.json - * - SOLVER_D3PLOT_COMPRESSION_TYPE - Specifies the type of D3PLOT compression to be used - Default is none. Options are based on site-specific configurations. Supported types include 7Z,ZIP,PLOTCPRS,FEMZIP,D3VIEW_COMP - * - SOLVER_IGNORE_INPUT_CP - Deprecated - - * - SOLVER_INPUT_FILE - Main solver input file - If the main solver input file is in compressed format, d3VIEW will uncompress and use a file that starts with main as the main solver file. The pattern can be changed by using SOLVER_MAIN_INPUT_PATTERN - * - SOLVER_VERSION - Solver version - This specifies the version of the Solver and depends on Site-specific configuration - * - SOLVER_PRECISION - Solver precision - This specifies the precision of the Solver and depends on Site-specific configuration - * - SOLVER_INTERCONNECT - Type of MPI Interconnect - Default is INTELMPI, Other options include OPENMPI,HPMPI - * - SOLVER_MEMORY - Main memory provided to the solver - This is the main memory in WORDS or MB or GB that can be specified - * - SOLVER_COSIM_CORES - COSIM cores - Used for COSIM solver - * - SOLVER_ARGS - Addition arguments for Solver - If defined, these will be directly passed to the solver execution command - * - SOLVER_SUPPORTED_TYPES - - - * - SOLVER_EXE - Binary for the specified version - If defined, these will be used for the solver binary path - * - SOLVER_BASE_DIR - Location where the solver files are loaded - If defined, all binary path not starting with forward-slash will be prefixed with this - * - SOLVER_ADD_ARGS - alias of SOLVER_ARGS - - * - SOLVER_RUN_SCRIPT - Solver run script - If defined, this will be used to execute the solver. The script will have access to all defined environment variables from the job - * - SOLVER_WORK_DIR - The directory where the solver is executed from - - * - SOLVER_RUN_TYPE - Execution type of the Solver - - * - SOLVER_GDATA - Deprecated - - * - SOLVER_USER_ARGS - alias of SOLVER_ARGS - - * - SOLVER_EXTRA_FILES - Extra files added to the solver - - * - SOLVER_JOB_NAME - Job name - - * - SOLVER_PFILE - Path to the PFILE used for Decomposition of LS-DYNA - - * - SOLVER_NCYCLE - Number of cycles to run for LS-DYNA - - * - SOLVER_USER_NCPU - Number of cores to use for Soler - - * - SOLVER_JOBID - Job id - - * - SOLVER_MAIN_MEMORY - Alias of SOLVER_MEMORY - - * - SOLVER_DECOMP_MEMORY - Secondary memory for the solver used for Decomposition - - * - SOLVER_TOTAL_NCPU - Total number of cores for the simulation - - * - SOLVER_NODE_NCPU - Number of nodes per Server - - * - SOLVER_MPI_TYPE - Same as SOLVER_INTERCONNECT - - * - SOLVER_LICENSE_SERVER - Solver license server - - * - SOLVER_RESULT_COMPRESS - Compress result files - - * - SOLVER_LOCAL_BASE - Deprecated - - * - SOLVER_TOTAL_NODES - Number of nodes used for the job - - * - SOLVER_KEEP_D3PLOT - Keep LS-DYNA D3plots after the simulation is complete - - * - SOLVER_JOB_ID - Job id - - * - SOLVER_LOCAL_DIR - Location where the solver files are available on the server - - * - SOLVER_START_DIR - Location where the simulation is submitted from - - * - SOLVER_NCPU - Total number of cores for the simulation - - * - SOLVER_CONVERT - Location to where CONVERT path is located for image processing - - * - SOLVER_INTERFACE_S - Interface linking file - - * - SOLVER_INTERFACE_L - Interface linking file - - * - SOLVER_INTERFACE_L_FILE - Interface linking file - - * - SOLVER_QUEUE - Main queue the job is sumitted into - - * - SOLVER_RUN_SHORT_PREVIEW - Option to run short preview - yes - * - SOLVER_RUN_LONG_PREVIEW - Option to run long preview - Yes - * - SOLVER_PREVIEW_SHORT_INTERVAL - Interval to run short preview - 120 - * - SOLVER_PREVIEW_LONG_INTERVAL - Interval to run long preview - 600 - * - SOLVER_REALTIME_PREVIEW - When enabled, the files are copied as it appears - - * - SOLVER_LONG_PREVIEW_TYPES - Type of long preview to run as simulation progresses - compressed,gen_images,apply_templates - * - SOLVER_ABORT_FILE - Type of file to create when user aborts the simulation - Depends on the Solver. D3KIL for LS-DYNA, ABORT for others - * - SOLVER_HUNG_CHECK - Check if the solver is hung - Default=no - * - SOLVER_HUNG_TERMINATE - Terminate if hung - Default=no - * - SOLVER_HUNG_CHECK_FILE - File to check for staleness - solver.log - * - SOLVER_HUNG_CHECK_ERROR_FILE - Error file to check to detect any errors are present - solver.err - * - SOLVER_ERROR_CHECK - Check error file - Default = no - * - SOLVER_ERROR_TOKENS - Types of error string to look for in error file - Default =error,Error,E r r o r - * - SOLVER_ERROR_WAIT - Wait time for error checking - - * - SOLVER_MPI_ENV - Environment variables for MPI - - * - SOLVER_MPI_APP_ENV - Alias of SOLVER_MPI_ENV - - * - SOLVER_RUN_PUBLISHER - Run templates after simulation completes - Default=no - * - SOLVER_DEALLOCATE_NODES - After simulation completes and if more than one node Is used, this deallocates other nodes - Default = no - * - SOLVER_RUN_IMAGE_CHAINER - Detect sequential images and chain them into a movie - Default=no - * - SOLVER_POST_SCRIPT - Script to run after job completes - Default=no - * - SOLVER_ABORT_INTERVAL - Wait time before aborting simulation if an ABORT file is detected - 120 - * - SOLVER_RUN_LONG_TERM_BACKUP - Location where files can be copied after simulation completes - Default=no - * - SOLVER_HUNG_CHECK_INTERVAL - How often to check for hung jobs - Deafult=120 - * - SOLVER_LICENSE_WAIT_TIMEOUT - Wait for licenses until they become available - Default=wait - * - SOLVER_MAIN_INPUT_PATTERN - Pattern to use while looking for main input file if in compressed format - When main input file is in compressed format such as ZIP, this pattern if defined will be used - * - SOLVER_COMPRESSION_BIN - Binary path to use for compression - Used in conjunction with SOLVER_D3PLOT_COMPRESSION_TYPE - * - SOLVER_COMRPESSION_ARGS - Arguments to be supplied for compression binary - - * - SOLVER_COMPRESSION_ENV - Environment variables for Compression binary - - * - SOLVER_COMPRESSION_APPEND - Applies for FEMZIP. IF defined, -UA will be used - Append states as they are created. Only applies for FEMZIP - * - SOLVER_RESERVE_CORE_FOR_PROCESSING - If long preview or short preview is enabled, this option will reserve a core - Helps to dedicate a core for previews - * - SOLVER_POST_EXECUTION_TIMEOUT - integer - If post-processing scripts run beyond this timeout, they will be terminated - Helps to avoid hanging or long - running post-processing scriptsmoba * - SOLVER_UNZIP_INPUT_FILES - string - When this is enabled and solver main input is not zipped, other files that may be zipped are unzipped - * - SOLVER_MPI_MODULES - string - List of modules separated by a comman that can be loaded - * - SOLVER_LOG_LEVEL - string - Type of logging level - Default=INFO * - SOLVER_RUN_EQ_LAUNCH - string - Option to specify if the execution is performed in the same directory as the launch directory. If no, the SOLVER_COMPUTE_DIR is used to create a new directory before execution starts - * - SOLVER_COMPUTE_DIR - string - Location on the compute node where the simulation is solved - * - SOLVER_ERROR_CHECK_FILES - string - Files to check if there is a error string from a solver so we can terminate when SOLVER_ERROR_CHECK=yes - * - SOLVER_AGGREGATE_MESSAGES - string - For LS-DYNA the message files are concatenated into one ALL_MESSAGES.txt file for debugging - * - SOLVER_GREP_ERRORS_TO_FILE - string - Grep errors from D3HSP/MES0* and store in a file Errors.txt - * - SOLVER_POST_SOLVE_COMPRESSION - string - Option to run on compression of files after the simulation is complete - * - SOLVER_POST_SOLVE_COMPRESSION_FILES - string - List of files separated by spaces to compress - * - SOLVER_POST_SOLVE_FILE_NAME - string - File name to compress data into when using SOLVER_POST_SOLVE_COMPRESION - * - SOLVER_POST_SOLVE_COMPRESSION_REMOVE_ORIG - string - Option to remove post-solve compressed files - * - SOLVER_LICENSE_FAILURE_RETRY - string - Option to run the solver again if there is a license failure - * - SOLVER_LICENSE_FAILURE_RETRIES - integer - Number of retries before giving up in the event of the license failure - * - SOLVER_LONG_TERM_BACKUP - string - After the simulation is complete, this allows us to copy the files to a remote location - * - SOLVER_LONG_TERM_HOST - string - Remote hostname or ip address - * - SOLVER_LONG_TERM_LOCATION - string - Remote location where the files are to be copied - * - SOLVER_LONG_TERM_REM - string - Remove files after copying to long term location. This option DOES NOT check if the files were copied successfully. Use once this is tested in your environment - * - SOLVER_LICENSE_FAILURE_ERRORS - String - Option to detect license of MPI errors and try again - * - SOLVER_LICENSE_FAILURE_FILES - string - Files to check for license or MPI errors - * - SOLVER_GREP_ERRORS - string - Option to grep errors from log files and save in a new file - * - SOLVER_GREP_ERRORS_FILES - string - List of files used to look for errors - * - SOLVER_GREP_ERRORS_PATTERN - string - Error pattern to look for in the files specified - * - SOLVER_PRE_SCRIPT_DATA - string - - * - SOLVER_POST_SRIPT_DATA - string - - * - SOLVER_SLURM_DOWN_NODES_ON_NETWORK_FAILURE - string - Files to check for license or MPI errors - * - SOLVER_GREP_ERRORS - string - This will detect network failure and take down nodes - * - SOLVER_SLURM_NETWORK_FAILURE_PATTERN - string - This will detect network failure and take down nodes - * - SOLVER_ONSTEP_FPIDS - string - - * - SOLVER_CHECK_LICENSE - string - This is available to verify the connection is good to the license server over the port before running. - * - SOLVER_LONG_TERM - string - - * - BINOUT_VERIFY_IDS - string - This is now optional based on SOLVER_BINOUT_VERIFY_IDS - * - AGGREGATE_AND_ERROR_GREP - string - is now optional using SOLVER_AGGREGATE_MESSAGES and SOLVER_GREP_ERRORS_TO_FILE - Table with links ======================= .. list-table:: List of Family. Each link can be used to access variable attributes :widths: 100 :header-rows: 1 * - Name of the Variable * - :ref:`SOLVER_TYPE` * - :ref:`SOLVER_D3PLOT_COMPRESSION_TYPE` * - :ref:`SOLVER_IGNORE_INPUT_CP` * - :ref:`SOLVER_INPUT_FILE` * - :ref:`SOLVER_VERSION` * - :ref:`SOLVER_PRECISION` * - :ref:`SOLVER_INTERCONNECT` * - :ref:`SOLVER_MEMORY` * - :ref:`SOLVER_COSIM_CORES` * - :ref:`SOLVER_ARGS` * - :ref:`SOLVER_SUPPORTED_TYPES` * - :ref:`SOLVER_EXE` * - :ref:`SOLVER_BASE_DIR` * - :ref:`SOLVER_ADD_ARGS` * - :ref:`SOLVER_RUN_SCRIPT` * - :ref:`SOLVER_WORK_DIR` * - :ref:`SOLVER_RUN_TYPE` * - :ref:`SOLVER_GDATA` * - :ref:`SOLVER_USER_ARGS` * - :ref:`SOLVER_EXTRA_FILES` * - :ref:`SOLVER_JOB_NAME` * - :ref:`SOLVER_PFILE` * - :ref:`SOLVER_NCYCLE` * - :ref:`SOLVER_USER_NCPU` * - :ref:`SOLVER_JOBID` * - :ref:`SOLVER_MAIN_MEMORY` * - :ref:`SOLVER_DECOMP_MEMORY` * - :ref:`SOLVER_TOTAL_NCPU` * - :ref:`SOLVER_NODE_NCPU` * - :ref:`SOLVER_MPI_TYPE` * - :ref:`SOLVER_LICENSE_SERVER` * - :ref:`SOLVER_RESULT_COMPRESS` * - :ref:`SOLVER_LOCAL_BASE` * - :ref:`SOLVER_TOTAL_NODES` * - :ref:`SOLVER_KEEP_D3PLOT` * - :ref:`SOLVER_JOB_ID` * - :ref:`SOLVER_LOCAL_DIR` * - :ref:`SOLVER_START_DIR` * - :ref:`SOLVER_NCPU` * - :ref:`SOLVER_CONVERT` * - :ref:`SOLVER_INTERFACE_S` * - :ref:`SOLVER_INTERFACE_L` * - :ref:`SOLVER_INTERFACE_L_FILE` * - :ref:`SOLVER_QUEUE` * - :ref:`SOLVER_RUN_SHORT_PREVIEW` * - :ref:`SOLVER_RUN_LONG_PREVIEW` * - :ref:`SOLVER_PREVIEW_SHORT_INTERVAL` * - :ref:`SOLVER_PREVIEW_LONG_INTERVAL` * - :ref:`SOLVER_REALTIME_PREVIEW` * - :ref:`SOLVER_LONG_PREVIEW_TYPES` * - :ref:`SOLVER_ABORT_FILE` * - :ref:`SOLVER_HUNG_CHECK` * - :ref:`SOLVER_HUNG_TERMINATE` * - :ref:`SOLVER_HUNG_CHECK_FILE` * - :ref:`SOLVER_HUNG_CHECK_ERROR_FILE` * - :ref:`SOLVER_ERROR_CHECK` * - :ref:`SOLVER_ERROR_TOKENS` * - :ref:`SOLVER_ERROR_WAIT` * - :ref:`SOLVER_MPI_ENV` * - :ref:`SOLVER_MPI_APP_ENV` * - :ref:`SOLVER_RUN_PUBLISHER` * - :ref:`SOLVER_DEALLOCATE_NODES` * - :ref:`SOLVER_RUN_IMAGE_CHAINER` * - :ref:`SOLVER_POST_SCRIPT` * - :ref:`SOLVER_ABORT_INTERVAL` * - :ref:`SOLVER_RUN_LONG_TERM_BACKUP` * - :ref:`SOLVER_HUNG_CHECK_INTERVAL` * - :ref:`SOLVER_LICENSE_WAIT_TIMEOUT` * - :ref:`SOLVER_MAIN_INPUT_PATTERN` * - :ref:`SOLVER_COMPRESSION_BIN` * - :ref:`SOLVER_COMRPESSION_ARGS` * - :ref:`SOLVER_COMPRESSION_ENV` * - :ref:`SOLVER_COMPRESSION_APPEND` * - :ref:`SOLVER_RESERVE_CORE_FOR_PROCESSING` * - :ref:`SOLVER_POST_EXECUTION_TIMEOUT` * - :ref:`SOLVER_UNZIP_INPUT_FILES` * - :ref:`SOLVER_MPI_MODULES` * - :ref:`SOLVER_LOG_LEVEL` * - :ref:`SOLVER_RUN_EQ_LAUNCH` * - :ref:`SOLVER_COMPUTE_DIR` * - :ref:`SOLVER_ERROR_CHECK_FILES` * - :ref:`SOLVER_AGGREGATE_MESSAGES` * - :ref:`SOLVER_GREP_ERRORS_TO_FILE` * - :ref:`SOLVER_POST_SOLVE_COMPRESSION` * - :ref:`SOLVER_POST_SOLVE_COMPRESSION_FILES` * - :ref:`SOLVER_POST_SOLVE_FILE_NAME` * - :ref:`SOLVER_POST_SOLVE_COMPRESSION_REMOVE_ORIG` * - :ref:`SOLVER_LICENSE_FAILURE_RETRY` * - :ref:`SOLVER_LICENSE_FAILURE_RETRIES` * - :ref:`SOLVER_LONG_TERM_BACKUP` * - :ref:`SOLVER_LONG_TERM_HOST` * - :ref:`SOLVER_LONG_TERM_LOCATION` * - :ref:`SOLVER_LONG_TERM_REM` * - :ref:`SOLVER_LICENSE_FAILURE_ERRORS` * - :ref:`SOLVER_LICENSE_FAILURE_FILES` * - :ref:`SOLVER_GREP_ERRORS` * - :ref:`SOLVER_GREP_ERRORS_FILES` * - :ref:`SOLVER_GREP_ERRORS_PATTERN` * - :ref:`SOLVER_PRE_SCRIPT_DATA` * - :ref:`SOLVER_POST_SRIPT_DATA` * - :ref:`SOLVER_SLURM_DOWN_NODES_ON_NETWORK_FAILURE` * - :ref:`SOLVER_SLURM_NETWORK_FAILURE_PATTERN` * - :ref:`SOLVER_ONSTEP_FPIDS` * - :ref:`SOLVER_CHECK_LICENSE` * - :ref:`SOLVER_LONG_TERM` * - :ref:`BINOUT_VERIFY_IDS` * - :ref:`AGGREGATE_AND_ERROR_GREP` Server options available while submitting a Job. ===================================================== Solver attributes ------------------ .. thumbnail:: /_images/solveratrributes.png :title: Solver attributes .. centered:: :sup:`Solver attributes` | Generate preview templtes -------------------------- .. thumbnail:: /_images/generatepreviewtemplates.png :title: Generate preview templtes .. centered:: :sup:`Generate preview templtes` | Solver Run Publisher --------------------- .. thumbnail:: /_images/solverrunpublisher.png :title: Solver Run Publisher .. centered:: :sup:`Solver Run Publisher` | Unzip input files ------------------- .. thumbnail:: /_images/unzipinputfiles.png :title: Unzip input files .. centered:: :sup:`Unzip input files` | Solver Precision ----------------- .. thumbnail:: /_images/solverprecision.png :title: Solver Precision .. centered:: :sup:`Solver Precision` | Generate Preview Images ------------------------ .. thumbnail:: /_images/generatepreviewimages.png :title: Generate Preview Images .. centered:: :sup:`Generate Preview Images` | Short/Long/State Preview intervals ----------------------------------- .. thumbnail:: /_images/shortlongstatepreview.png :title: Short/Long/State Preview intervals .. centered:: :sup:`Short/Long/State Preview intervals` | Terminate/Hung ------------------ .. thumbnail:: /_images/terminatehung.png :title: Terminate/Hung .. centered:: :sup:`Terminate/Hung` | Error check -------------- .. thumbnail:: /_images/errorcheck.png :title: Error Check .. centered:: :sup:`Error Check` | Specify the files for compression ----------------------------------- .. thumbnail:: /_images/specifyfilesforcompresion.png :title: Specify the files for compression .. centered:: :sup:`Specify the files for compression` |