WARPXM v1.10.0
Loading...
Searching...
No Matches
warpy.warpy_config Namespace Reference

Configuration file for WARPy. More...

Functions

def test_rundir (category, name)
 Function for computing the directory to use for running the simulation.
 

Variables

bool clobber_directory = False
 
bool allow_rundir_overwrite = True
 
bool copy_warpy_file = True
 
bool write_git_info = True
 
str git_repo = '@PROJECT_SOURCE_DIR@'
 
int num_procs = 0
 
str warpxm_exec = '@WARPXM_EXEC@'
 
str mpirun = '@MPIEXEC_COMPAT@'
 
str mpi_np = '-np'
 
str meshes_base_dir = '.'
 
dict env_vars = {'OPENBLAS_NUM_THREADS': 1, 'MKL_NUM_THREADS': 1}
 
list mpi_args = []
 
os user_config_path = os.path.join(os.environ['HOME'], '.config', 'warpy_user_config.py')
 
None queue = None
 
str account = ''
 
None walltime = None
 
None memory_limit = None
 
str pbs_template_file = '@PBS_TEMPLATE_FILE@'
 
str slurm_template_file = '@SLURM_TEMPLATE_FILE@'
 
str warpxm_source_dir = '@PROJECT_SOURCE_DIR@'
 

Detailed Description

Configuration file for WARPy.

Function Documentation

◆ test_rundir()

def warpy.warpy_config.test_rundir (   category,
  name 
)

Function for computing the directory to use for running the simulation.

Parameters
categorycategory of the simulation
nametest case name
Returns
The path where the sumulation should be run. This is relative to the current working directory (if a relative path is returned).

Variable Documentation

◆ account

str warpy.warpy_config.account = ''

◆ allow_rundir_overwrite

bool warpy.warpy_config.allow_rundir_overwrite = True

◆ clobber_directory

bool warpy.warpy_config.clobber_directory = False

◆ copy_warpy_file

bool warpy.warpy_config.copy_warpy_file = True

◆ env_vars

dict warpy.warpy_config.env_vars = {'OPENBLAS_NUM_THREADS': 1, 'MKL_NUM_THREADS': 1}

◆ git_repo

str warpy.warpy_config.git_repo = '@PROJECT_SOURCE_DIR@'

◆ memory_limit

None warpy.warpy_config.memory_limit = None

◆ meshes_base_dir

str warpy.warpy_config.meshes_base_dir = '.'

◆ mpi_args

list warpy.warpy_config.mpi_args = []

◆ mpi_np

str warpy.warpy_config.mpi_np = '-np'

◆ mpirun

str warpy.warpy_config.mpirun = '@MPIEXEC_COMPAT@'

◆ num_procs

int warpy.warpy_config.num_procs = 0

◆ pbs_template_file

str warpy.warpy_config.pbs_template_file = '@PBS_TEMPLATE_FILE@'

◆ queue

None warpy.warpy_config.queue = None

◆ slurm_template_file

str warpy.warpy_config.slurm_template_file = '@SLURM_TEMPLATE_FILE@'

◆ user_config_path

os warpy.warpy_config.user_config_path = os.path.join(os.environ['HOME'], '.config', 'warpy_user_config.py')

◆ walltime

None warpy.warpy_config.walltime = None

◆ warpxm_exec

str warpy.warpy_config.warpxm_exec = '@WARPXM_EXEC@'

◆ warpxm_source_dir

str warpy.warpy_config.warpxm_source_dir = '@PROJECT_SOURCE_DIR@'

◆ write_git_info

bool warpy.warpy_config.write_git_info = True