carputils
Doxygen code documentation for the python framework controlling openCARP
All Classes Namespaces Files Functions Variables Properties Pages
Classes | Functions
carputils.settings.paths Namespace Reference

Classes

class  Path
 
class  PathSettingsNamespace
 Modified namespace with extra error handling for paths. More...
 

Functions

def join_add (parts)
 
def carp_executable (exedir, start='carp')
 Select the most recent openCARP/bench/etc. More...
 
def dirs (config, cli)
 Determine the directories to look for executables. More...
 
def execs (config, dirs)
 Generate the executable paths for the current run configuration. More...
 

Function Documentation

◆ carp_executable()

def carputils.settings.paths.carp_executable (   exedir,
  start = 'carp' 
)

Select the most recent openCARP/bench/etc.

executable in the exe dir

Parameters

exedir str or Path The path of the openCARP bin directory start str, optional The beginning of the executable name (default: 'openCARP.')

Returns

str The path of the file (or link) to the most recently built executable starting with the specified string

◆ dirs()

def carputils.settings.paths.dirs (   config,
  cli 
)

Determine the directories to look for executables.

◆ execs()

def carputils.settings.paths.execs (   config,
  dirs 
)

Generate the executable paths for the current run configuration.

◆ join_add()

def carputils.settings.paths.join_add (   parts)