viktor.external.dgeostability
DGeoStabilityAnalysis
- class viktor.external.dgeostability.DGeoStabilityAnalysis(input_file)
Bases:
ExternalProgram
DGeoStabilityAnalysis can be used to perform an analysis using DGeoStability 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 methodget_output_file()
, afterexecute()
.Usage:
dgeostability_analysis = DGeoStabilityAnalysis(input_file=input_file) dgeostability_analysis.execute(timeout=10) output_file = dgeostability_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
]) – .sti input file.
- get_output_file(extension='.sto', *, as_file=False)
Method can be used to retrieve the results generated by running an external analysis. Call method
execute()
first andget_output_file()
afterwards.- Parameters:
extension (
str
) – extension of the file you want to return; ‘.sto’, ‘.error.log’, ‘.err’as_file (
bool
) – Return as BytesIO (default) or FileNew in v13.5.0
- Return type:
Union
[BytesIO
,File
,None
]