From 35b596a53cd7f005af8bb56d9c44da71101adb8b Mon Sep 17 00:00:00 2001 From: Magne Sjaastad Date: Mon, 2 Sep 2019 15:11:34 +0200 Subject: [PATCH] Python doc : Add doc directly in client code for export flow characteristics --- .../GrpcInterface/Python/rips/Commands.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/ApplicationCode/GrpcInterface/Python/rips/Commands.py b/ApplicationCode/GrpcInterface/Python/rips/Commands.py index ced55b5bfc..dafeec9518 100644 --- a/ApplicationCode/GrpcInterface/Python/rips/Commands.py +++ b/ApplicationCode/GrpcInterface/Python/rips/Commands.py @@ -263,6 +263,19 @@ class Commands: return self.__execute(createSaturationPressurePlots=Cmd.CreateSatPressPlotRequest(caseIds=caseIds)) def exportFlowCharacteristics(self, caseId, timeSteps, injectors, producers, fileName, minimumCommunication=0.0, aquiferCellThreshold=0.1): + """ Export Flow Characteristics data to text file in CSV format + + Parameter | Description | Type + ------------------------- | --------------------------------------------- | ----- + caseId | ID of case | Integer + timeSteps | Time step indices | List of Integer + injectors | Injector names | List of Strings + producers | Producer names | List of Strings + fileName | Export file name | Integer + minimumCommunication | Minimum Communication, defaults to 0.0 | Integer + aquiferCellThreshold | Aquifer Cell Threshold, defaults to 0.1 | Integer + + """ if isinstance(timeSteps, int): timeSteps = [timeSteps] if isinstance(injectors, str):