viktor.external.dsheetpiling

DSheetPilingAnalysis

class viktor.external.dsheetpiling.DSheetPilingAnalysis(input_file)

Bases: ExternalProgram

DSheetPilingAnalysis can be used to perform an analysis using D-Sheet Piling on a third-party worker. To start an analysis call the method execute(), with an appropriate timeout (in seconds). To retrieve the results call the method get_output_file(), after execute().

Usage:

dsheetpiling_analysis = DSheetPilingAnalysis(input_file=input_file)
dsheetpiling_analysis.execute(timeout=10)
output_file = dsheetpiling_analysis.get_output_file()

Exceptions which can be raised during calculation: - viktor.errors.ExecutionError: generic error. Error message provides more information

Parameters:

input_file (Union[BytesIO, File]) – .shi input file.

get_output_file(extension='.shd', *, as_file=False)

Method can be used to retrieve the results generated by running an external analysis. Call method execute() first and get_output_file() afterwards.

Parameters:

• extension (str) – extension of the file you want to return; one of: ‘.shd’, ‘.shs’, ‘.shl’, ‘.sho’, ‘.error.log’, ‘.err’

• as_file (bool) – Return as BytesIO (default) or File

  New in v13.5.0

Return type:

Union[BytesIO, File, None]