pySIMsalabim.install package

Submodules

pySIMsalabim.install.compile_simsalabim module

Compile program with fpc

pySIMsalabim.install.compile_simsalabim.fpc_prog(prog_name, path2prog, show_term_output=True, force_fpc=True, verbose=True)[source]

Compile program using fpc

Parameters:

  • prog_name (str) – Program name (e.g. ‘SimSS’, ‘zimt’, ‘SIMsalabim)

  • path2prog (str) – String of the absolute path to the program

  • show_term_output (bool, optional) – show terminal output from the compilation, by default True

  • force_fpc (bool, optional) – force recompile with fpc even if compiled program already exists, by default True

  • verbose (bool, optional) – print output of the compilation, by default True

pySIMsalabim.install.get_SIMsalabim module

pySIMsalabim.install.get_SIMsalabim.clear_current_working_directory(cwd, folder_name='kostergroup-SIMsalabim-')[source]

_summary_

Parameters:

  • cwd (string) – Current working directory

  • folder_name (string, optional) – Name of the folder to download, by default ‘kostergroup-SIMsalabim-’

Returns:

Whether the folder was removed or not

Return type:

bool

pySIMsalabim.install.get_SIMsalabim.cmd_yes_no_question(question, default='yes')[source]

_summary_

Parameters:

  • question (str) – question to ask the user

  • default (str, optional) – default answer, by default “yes”

Returns:

whether the default answer is valid or not

Return type:

bool

Raises:

ValueError – If the default answer is not valid

pySIMsalabim.install.get_SIMsalabim.fpc_prog(cwd, prog_name, show_term_output=True, force_fpc=True, verbose=True)[source]

Compile program using fpc

Parameters:

  • cwd (string) – String of the absolute path to the program

  • prog_name (string) – Name of the program to compile

  • show_term_output (bool, optional) – show terminal output from the compilation, by default True

  • force_fpc (bool, optional) – force recompile with fpc even if compiled program already exists, by default True

  • verbose (bool, optional) – print output of the compilation, by default True

pySIMsalabim.install.get_SIMsalabim.get_SIMsalabim_assets(cwd, folder_name='kostergroup-SIMsalabim-', verbose=False)[source]

Get the latest compiled binaries from the Kostergroup Github

Parameters:

  • cwd (string) – Current working directory

  • folder_name (string, optional) – Name of the folder to download, by default ‘kostergroup-SIMsalabim-’

  • verbose (bool, optional) – Print verbose output, by default False

Returns:

  • int

  • 0 (Success)

  • 1 (Success)

  • 2 (Failed)

  • 3 (Failed)

pySIMsalabim.install.get_SIMsalabim.get_SIMsalabim_source(cwd, folder_name='kostergroup-SIMsalabim-', verbose=False)[source]

Get the latest release from the Kostergroup Github

Parameters:

  • cwd (string) – Current working directory

  • folder_name (string, optional) – Name of the folder to download, by default ‘kostergroup-SIMsalabim-’

  • verbose (bool, optional) – Print verbose output, by default False

Returns:

  • int

  • 0 (Success)

  • 2 (Failed)

  • 3 (Failed)

pySIMsalabim.install.get_SIMsalabim.install_SIMsalabim(cwd, folder_name='kostergroup-SIMsalabim-', verbose=False)[source]

Install SIMsalabim in the current working directory

Parameters:

  • cwd (string) – Current working directory

  • folder_name (string, optional) – Name of the folder to download, by default ‘kostergroup-SIMsalabim-’

  • verbose (bool, optional) – Print verbose output, by default False

Returns:

  • int

  • 0 (Success)

  • 1 (Success)

  • 2 (Failed)

  • 3 (Failed)

pySIMsalabim.install.get_SIMsalabim.install_fpc_Linux()[source]

Install Free Pascal Compiler on Linux

pySIMsalabim.install.get_SIMsalabim.use_SIMsalabim_source(cwd, folder_name='kostergroup-SIMsalabim-')[source]

Use the SIMsalabim source code

Parameters:

  • cwd (string) – Current working directory

  • folder_name (string, optional) – Name of the folder to download, by default ‘kostergroup-SIMsalabim-’

Returns:

  • int

  • 0 (Success)

  • 2 (Failed)

  • 3 (Failed)

pySIMsalabim.install.get_gnu_parallel module

install GNU parallel

pySIMsalabim.install.get_gnu_parallel.install_GNU_parallel_Linux(verbose=True)[source]

Download GNU parallel if on Linux and install it if possible (requires sudo)

Parameters:

verbose (bool, optional) – Print the download progress, by default False

Return type:

None

Raises:

Exception – If GNU parallel could not be installed

Module contents