From ead29ef70f1935fc52aaccce9ee5e963163c4faf Mon Sep 17 00:00:00 2001 From: Magne Sjaastad Date: Mon, 30 Mar 2020 14:07:04 +0200 Subject: [PATCH] Python Doc : Improve formatting of tables --- .../GrpcInterface/Python/rips/case.py | 175 ++++++++++-------- .../GrpcInterface/Python/rips/instance.py | 47 +++-- .../GrpcInterface/Python/rips/view.py | 66 +++---- docs/rips/case.py | 175 ++++++++++-------- docs/rips/instance.py | 47 +++-- docs/rips/view.py | 66 +++---- 6 files changed, 310 insertions(+), 266 deletions(-) diff --git a/ApplicationCode/GrpcInterface/Python/rips/case.py b/ApplicationCode/GrpcInterface/Python/rips/case.py index 3d307d2d77..79afb1ef20 100644 --- a/ApplicationCode/GrpcInterface/Python/rips/case.py +++ b/ApplicationCode/GrpcInterface/Python/rips/case.py @@ -179,23 +179,23 @@ def cell_info_for_active_cells(self, porosity_model="MATRIX_MODEL"): Returns: List of **CellInfo** objects - ### CellInfo class description + **CellInfo class description**:: - Parameter | Description | Type - ------------------------- | --------------------------------------------- | ----- - grid_index | Index to grid | Integer - parent_grid_index | Index to parent grid | Integer - coarsening_box_index | Index to coarsening box | Integer - local_ijk | Cell index in IJK directions of local grid | Vec3i - parent_ijk | Cell index in IJK directions of parent grid | Vec3i + Parameter | Description | Type + ------------------------- | --------------------------------------------- | ----- + grid_index | Index to grid | Integer + parent_grid_index | Index to parent grid | Integer + coarsening_box_index | Index to coarsening box | Integer + local_ijk | Cell index in IJK directions of local grid | Vec3i + parent_ijk | Cell index in IJK directions of parent grid | Vec3i - ### Vec3i class description + **Vec3i class description**:: - Parameter | Description | Type - ---------------- | -------------------------------------------- | ----- - i | I grid index | Integer - j | J grid index | Integer - k | K grid index | Integer + Parameter | Description | Type + ---------------- | -------------------------------------------- | ----- + i | I grid index | Integer + j | J grid index | Integer + k | K grid index | Integer """ active_cell_info_chunks = self.cell_info_for_active_cells_async( @@ -210,16 +210,18 @@ def cell_info_for_active_cells(self, porosity_model="MATRIX_MODEL"): def time_steps(self): """Get a list containing all time steps - The time steps are defined by the class **TimeStepDate** : + The time steps are defined by the class **TimeStepDate** - Type | Name - --------- | ---------- - int | year - int | month - int | day - int | hour - int | minute - int | second + **TimeStepDate class description**:: + + Type | Name + --------- | ---------- + int | year + int | month + int | day + int | hour + int | minute + int | second """ @@ -297,38 +299,40 @@ def export_well_path_completions( """ Export well path completions for the current case to file - Parameter | Description | Type - ----------------------------| ------------------------------------------------ | ----- - time_step | Time step to export for | Integer - well_path_names | List of well path names | List - file_split | Controls how export data is split into files | String enum - compdat_export | Compdat export type | String enum - include_perforations | Export perforations? | bool - include_fishbones | Export fishbones? | bool - fishbones_exclude_main_bore | Exclude main bore when exporting fishbones? | bool - combination_mode | Settings for multiple completions in same cell | String Enum + **Parameters**:: - ##### Enum file_split + Parameter | Description | Type + ----------------------------| ------------------------------------------------ | ----- + time_step | Time step to export for | Integer + well_path_names | List of well path names | List + file_split | Controls how export data is split into files | String enum + compdat_export | Compdat export type | String enum + include_perforations | Export perforations? | bool + include_fishbones | Export fishbones? | bool + fishbones_exclude_main_bore | Exclude main bore when exporting fishbones? | bool + combination_mode | Settings for multiple completions in same cell | String Enum - Option | Description - ----------------------------------- | ------------ - "UNIFIED_FILE" | A single file with all combined transmissibilities - "SPLIT_ON_WELL" | One file for each well with combined transmissibilities - "SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well + **Enum file_split**:: - ##### Enum compdat_export + Option | Description + ----------------------------------- | ------------ + "UNIFIED_FILE" | A single file with all combined transmissibilities + "SPLIT_ON_WELL" | One file for each well with combined transmissibilities + "SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well - Option | Description - ------------------------------------------- | ------------ - "TRANSMISSIBILITIES" | Direct export of transmissibilities - "WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include WPIMULT in addition to transmissibilities + **Enum compdat_export**:: - ##### Enum combination_mode + Option | Description + ------------------------------------------- | ------------ + "TRANSMISSIBILITIES" | Direct export of transmissibilities + "WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include WPIMULT in addition to transmissibilities - Option | Description - ------------------- | ------------ - "INDIVIDUALLY" | Exports the different completion types into separate sections - "COMBINED" | Export one combined transmissibility for each cell + **Enum combination_mode**:: + + Option | Description + ------------------- | ------------ + "INDIVIDUALLY" | Exports the different completion types into separate sections + "COMBINED" | Export one combined transmissibility for each cell """ if isinstance(well_path_names, str): @@ -372,16 +376,19 @@ def create_multiple_fractures( """ Create Multiple Fractures in one go - Parameter | Description | Type - -----------------------| ----------------------------------------- | ----- - template_id | Id of the template | Integer - well_path_names | List of well path names | List of Strings - min_dist_from_well_td | Minimum distance from well TD | Double - max_fractures_per_well | Max number of fractures per well | Integer - top_layer | Top grid k-level for fractures | Integer - base_layer | Base grid k-level for fractures | Integer - spacing | Spacing between fractures | Double - action | 'APPEND_FRACTURES' or 'REPLACE_FRACTURES' | String enum + **Parameters**:: + + Parameter | Description | Type + -----------------------| ----------------------------------------- | ----- + template_id | Id of the template | Integer + well_path_names | List of well path names | List of Strings + min_dist_from_well_td | Minimum distance from well TD | Double + max_fractures_per_well | Max number of fractures per well | Integer + top_layer | Top grid k-level for fractures | Integer + base_layer | Base grid k-level for fractures | Integer + spacing | Spacing between fractures | Double + action | 'APPEND_FRACTURES' or 'REPLACE_FRACTURES' | String enum + """ if isinstance(well_path_names, str): well_path_names = [well_path_names] @@ -411,22 +418,24 @@ def create_lgr_for_completion( """ Create a local grid refinement for the completions on the given well paths - Parameter | Description | Type - --------------- | -------------------------------------- | ----- - time_steps | Time step index | Integer - well_path_names | List of well path names | List of Strings - refinement_i | Refinment in x-direction | Integer - refinement_j | Refinment in y-direction | Integer - refinement_k | Refinment in z-direction | Integer - split_type | Defines how to split LGRS | String enum + **Parameters**:: - ##### Enum split_type + Parameter | Description | Type + --------------- | -------------------------------------- | ----- + time_steps | Time step index | Integer + well_path_names | List of well path names | List of Strings + refinement_i | Refinment in x-direction | Integer + refinement_j | Refinment in y-direction | Integer + refinement_k | Refinment in z-direction | Integer + split_type | Defines how to split LGRS | String enum - Option | Description - ------------------------| ------------ - "LGR_PER_CELL" | One LGR for each completed cell - "LGR_PER_COMPLETION" | One LGR for each completion (fracture, perforation, ...) - "LGR_PER_WELL" | One LGR for each well + **Enum split_type**:: + + Option | Description + ------------------------| ------------ + "LGR_PER_CELL" | One LGR for each completed cell + "LGR_PER_COMPLETION" | One LGR for each completion (fracture, perforation, ...) + "LGR_PER_WELL" | One LGR for each well """ if isinstance(well_path_names, str): @@ -464,14 +473,16 @@ def export_flow_characteristics( ): """ Export Flow Characteristics data to text file in CSV format - Parameter | Description | Type - ------------------------- | --------------------------------------------- | ----- - time_steps | Time step indices | List of Integer - injectors | Injector names | List of Strings - producers | Producer names | List of Strings - file_name | Export file name | Integer - minimum_communication | Minimum Communication, defaults to 0.0 | Integer - aquifer_cell_threshold | Aquifer Cell Threshold, defaults to 0.1 | Integer + **Parameters**:: + + Parameter | Description | Type + ------------------------- | --------------------------------------------- | ----- + time_steps | Time step indices | List of Integer + injectors | Injector names | List of Strings + producers | Producer names | List of Strings + file_name | Export file name | Integer + minimum_communication | Minimum Communication, defaults to 0.0 | Integer + aquifer_cell_threshold | Aquifer Cell Threshold, defaults to 0.1 | Integer """ if isinstance(time_steps, int): @@ -498,7 +509,7 @@ def available_properties(self, """Get a list of available properties Arguments: - property_type (str): string corresponding to property_type enum. Choices: + property_type (str): string corresponding to property_type enum. Choices:: - DYNAMIC_NATIVE - STATIC_NATIVE - SOURSIMRL diff --git a/ApplicationCode/GrpcInterface/Python/rips/instance.py b/ApplicationCode/GrpcInterface/Python/rips/instance.py index 1c85198985..be0b288c4c 100644 --- a/ApplicationCode/GrpcInterface/Python/rips/instance.py +++ b/ApplicationCode/GrpcInterface/Python/rips/instance.py @@ -225,20 +225,22 @@ class Instance: """ Set the export folder used for all export functions - Parameter | Description | Type - ---------------- | -------------------------------------------- | ----- - export_type | String specifying what to export | String - path | Path to folder | String - create_folder | Create folder if it doesn't exist? | Boolean + **Parameters**:: - ##### Enum export_type + Parameter | Description | Type + ---------------- | -------------------------------------------- | ----- + export_type | String specifying what to export | String + path | Path to folder | String + create_folder | Create folder if it doesn't exist? | Boolean - Option | Description - --------------- | ------------ - "COMPLETIONS" | - "SNAPSHOTS" | - "PROPERTIES" | - "STATISTICS" | + **Enum export_type**:: + + Option | Description + --------------- | ------------ + "COMPLETIONS" | + "SNAPSHOTS" | + "PROPERTIES" | + "STATISTICS" | """ return self.__execute_command(setExportFolder=Cmd.SetExportFolderRequest( @@ -248,10 +250,13 @@ class Instance: """ Set the main window size in pixels - Parameter | Description | Type - --------- | ---------------- | ----- - width | Width in pixels | Integer - height | Height in pixels | Integer + **Parameters**:: + + Parameter | Description | Type + --------- | ---------------- | ----- + width | Width in pixels | Integer + height | Height in pixels | Integer + """ return self.__execute_command(setMainWindowSize=Cmd.SetWindowSizeParams( width=width, height=height)) @@ -260,10 +265,12 @@ class Instance: """ Set the plot window size in pixels - Parameter | Description | Type - --------- | ---------------- | ----- - width | Width in pixels | Integer - height | Height in pixels | Integer + **Parameters**:: + + Parameter | Description | Type + --------- | ---------------- | ----- + width | Width in pixels | Integer + height | Height in pixels | Integer """ return self.__execute_command(setPlotWindowSize=Cmd.SetWindowSizeParams( width=width, height=height)) diff --git a/ApplicationCode/GrpcInterface/Python/rips/view.py b/ApplicationCode/GrpcInterface/Python/rips/view.py index fd5418e8c3..8afab04cbe 100644 --- a/ApplicationCode/GrpcInterface/Python/rips/view.py +++ b/ApplicationCode/GrpcInterface/Python/rips/view.py @@ -14,7 +14,7 @@ def apply_cell_result(self, result_type, result_variable): """Apply a regular cell result Arguments: - result_type (str): String representing the result category. The valid values are + result_type (str): String representing the result category. The valid values are:: - DYNAMIC_NATIVE - STATIC_NATIVE - SOURSIMRL @@ -39,21 +39,23 @@ def apply_flow_diagnostics_cell_result( producers=None): """Apply a flow diagnostics cell result - Parameter | Description | Type - ------------------- | ------------------------------------------------------ | ----- - result_variable | String representing the result value | String - selection_mode | String specifying which tracers to select | String - injectors | List of injector names, used by 'FLOW_TR_BY_SELECTION' | String List - producers | List of injector names, used by 'FLOW_TR_BY_SELECTION' | String List + **Parameters**:: - ##### Enum compdat_export + Parameter | Description | Type + ------------------- | ------------------------------------------------------ | ----- + result_variable | String representing the result value | String + selection_mode | String specifying which tracers to select | String + injectors | List of injector names, used by 'FLOW_TR_BY_SELECTION' | String List + producers | List of injector names, used by 'FLOW_TR_BY_SELECTION' | String List - Option | Description - ------------------------| ------------ - "TOF" | Time of flight - "Fraction" | Fraction - "MaxFractionTracer" | Max Fraction Tracer - "Communication" | Communication + **Enum compdat_export**:: + + Option | Description + ------------------------| ------------ + "TOF" | Time of flight + "Fraction" | Fraction + "MaxFractionTracer" | Max Fraction Tracer + "Communication" | Communication """ if injectors is None: @@ -89,27 +91,29 @@ def export_sim_well_fracture_completions(self, time_step, compdat_export): """Export fracture completions for simulation wells - Parameter | Description | Type - ----------------------------| ------------------------------------------------ | ----- - time_step | Time step to export for | Integer - simulation_well_names | List of simulation well names | List - file_split | Controls how export data is split into files | String enum - compdat_export | Compdat export type | String enum + **Parameters**:: - ##### Enum file_split + Parameter | Description | Type + ----------------------------| ------------------------------------------------ | ----- + time_step | Time step to export for | Integer + simulation_well_names | List of simulation well names | List + file_split | Controls how export data is split into files | String enum + compdat_export | Compdat export type | String enum - Option | Description - ----------------------------------- | ------------ - "UNIFIED_FILE" Default Option| A single file with all transmissibilities - "SPLIT_ON_WELL" | One file for each well transmissibilities - "SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well + **Enum file_split**:: - ##### Enum compdat_export + Option | Description + ----------------------------------- | ------------ + "UNIFIED_FILE" Default Option| A single file with all transmissibilities + "SPLIT_ON_WELL" | One file for each well transmissibilities + "SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well - Option | Description - -----------------------------------------| ------------ - "TRANSMISSIBILITIES"Default Option| Direct export of transmissibilities - "WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include export of WPIMULT + **Enum compdat_export**:: + + Option | Description + -----------------------------------------| ------------ + "TRANSMISSIBILITIES"Default Option| Direct export of transmissibilities + "WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include export of WPIMULT """ if isinstance(simulation_well_names, str): diff --git a/docs/rips/case.py b/docs/rips/case.py index 3d307d2d77..79afb1ef20 100644 --- a/docs/rips/case.py +++ b/docs/rips/case.py @@ -179,23 +179,23 @@ def cell_info_for_active_cells(self, porosity_model="MATRIX_MODEL"): Returns: List of **CellInfo** objects - ### CellInfo class description + **CellInfo class description**:: - Parameter | Description | Type - ------------------------- | --------------------------------------------- | ----- - grid_index | Index to grid | Integer - parent_grid_index | Index to parent grid | Integer - coarsening_box_index | Index to coarsening box | Integer - local_ijk | Cell index in IJK directions of local grid | Vec3i - parent_ijk | Cell index in IJK directions of parent grid | Vec3i + Parameter | Description | Type + ------------------------- | --------------------------------------------- | ----- + grid_index | Index to grid | Integer + parent_grid_index | Index to parent grid | Integer + coarsening_box_index | Index to coarsening box | Integer + local_ijk | Cell index in IJK directions of local grid | Vec3i + parent_ijk | Cell index in IJK directions of parent grid | Vec3i - ### Vec3i class description + **Vec3i class description**:: - Parameter | Description | Type - ---------------- | -------------------------------------------- | ----- - i | I grid index | Integer - j | J grid index | Integer - k | K grid index | Integer + Parameter | Description | Type + ---------------- | -------------------------------------------- | ----- + i | I grid index | Integer + j | J grid index | Integer + k | K grid index | Integer """ active_cell_info_chunks = self.cell_info_for_active_cells_async( @@ -210,16 +210,18 @@ def cell_info_for_active_cells(self, porosity_model="MATRIX_MODEL"): def time_steps(self): """Get a list containing all time steps - The time steps are defined by the class **TimeStepDate** : + The time steps are defined by the class **TimeStepDate** - Type | Name - --------- | ---------- - int | year - int | month - int | day - int | hour - int | minute - int | second + **TimeStepDate class description**:: + + Type | Name + --------- | ---------- + int | year + int | month + int | day + int | hour + int | minute + int | second """ @@ -297,38 +299,40 @@ def export_well_path_completions( """ Export well path completions for the current case to file - Parameter | Description | Type - ----------------------------| ------------------------------------------------ | ----- - time_step | Time step to export for | Integer - well_path_names | List of well path names | List - file_split | Controls how export data is split into files | String enum - compdat_export | Compdat export type | String enum - include_perforations | Export perforations? | bool - include_fishbones | Export fishbones? | bool - fishbones_exclude_main_bore | Exclude main bore when exporting fishbones? | bool - combination_mode | Settings for multiple completions in same cell | String Enum + **Parameters**:: - ##### Enum file_split + Parameter | Description | Type + ----------------------------| ------------------------------------------------ | ----- + time_step | Time step to export for | Integer + well_path_names | List of well path names | List + file_split | Controls how export data is split into files | String enum + compdat_export | Compdat export type | String enum + include_perforations | Export perforations? | bool + include_fishbones | Export fishbones? | bool + fishbones_exclude_main_bore | Exclude main bore when exporting fishbones? | bool + combination_mode | Settings for multiple completions in same cell | String Enum - Option | Description - ----------------------------------- | ------------ - "UNIFIED_FILE" | A single file with all combined transmissibilities - "SPLIT_ON_WELL" | One file for each well with combined transmissibilities - "SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well + **Enum file_split**:: - ##### Enum compdat_export + Option | Description + ----------------------------------- | ------------ + "UNIFIED_FILE" | A single file with all combined transmissibilities + "SPLIT_ON_WELL" | One file for each well with combined transmissibilities + "SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well - Option | Description - ------------------------------------------- | ------------ - "TRANSMISSIBILITIES" | Direct export of transmissibilities - "WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include WPIMULT in addition to transmissibilities + **Enum compdat_export**:: - ##### Enum combination_mode + Option | Description + ------------------------------------------- | ------------ + "TRANSMISSIBILITIES" | Direct export of transmissibilities + "WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include WPIMULT in addition to transmissibilities - Option | Description - ------------------- | ------------ - "INDIVIDUALLY" | Exports the different completion types into separate sections - "COMBINED" | Export one combined transmissibility for each cell + **Enum combination_mode**:: + + Option | Description + ------------------- | ------------ + "INDIVIDUALLY" | Exports the different completion types into separate sections + "COMBINED" | Export one combined transmissibility for each cell """ if isinstance(well_path_names, str): @@ -372,16 +376,19 @@ def create_multiple_fractures( """ Create Multiple Fractures in one go - Parameter | Description | Type - -----------------------| ----------------------------------------- | ----- - template_id | Id of the template | Integer - well_path_names | List of well path names | List of Strings - min_dist_from_well_td | Minimum distance from well TD | Double - max_fractures_per_well | Max number of fractures per well | Integer - top_layer | Top grid k-level for fractures | Integer - base_layer | Base grid k-level for fractures | Integer - spacing | Spacing between fractures | Double - action | 'APPEND_FRACTURES' or 'REPLACE_FRACTURES' | String enum + **Parameters**:: + + Parameter | Description | Type + -----------------------| ----------------------------------------- | ----- + template_id | Id of the template | Integer + well_path_names | List of well path names | List of Strings + min_dist_from_well_td | Minimum distance from well TD | Double + max_fractures_per_well | Max number of fractures per well | Integer + top_layer | Top grid k-level for fractures | Integer + base_layer | Base grid k-level for fractures | Integer + spacing | Spacing between fractures | Double + action | 'APPEND_FRACTURES' or 'REPLACE_FRACTURES' | String enum + """ if isinstance(well_path_names, str): well_path_names = [well_path_names] @@ -411,22 +418,24 @@ def create_lgr_for_completion( """ Create a local grid refinement for the completions on the given well paths - Parameter | Description | Type - --------------- | -------------------------------------- | ----- - time_steps | Time step index | Integer - well_path_names | List of well path names | List of Strings - refinement_i | Refinment in x-direction | Integer - refinement_j | Refinment in y-direction | Integer - refinement_k | Refinment in z-direction | Integer - split_type | Defines how to split LGRS | String enum + **Parameters**:: - ##### Enum split_type + Parameter | Description | Type + --------------- | -------------------------------------- | ----- + time_steps | Time step index | Integer + well_path_names | List of well path names | List of Strings + refinement_i | Refinment in x-direction | Integer + refinement_j | Refinment in y-direction | Integer + refinement_k | Refinment in z-direction | Integer + split_type | Defines how to split LGRS | String enum - Option | Description - ------------------------| ------------ - "LGR_PER_CELL" | One LGR for each completed cell - "LGR_PER_COMPLETION" | One LGR for each completion (fracture, perforation, ...) - "LGR_PER_WELL" | One LGR for each well + **Enum split_type**:: + + Option | Description + ------------------------| ------------ + "LGR_PER_CELL" | One LGR for each completed cell + "LGR_PER_COMPLETION" | One LGR for each completion (fracture, perforation, ...) + "LGR_PER_WELL" | One LGR for each well """ if isinstance(well_path_names, str): @@ -464,14 +473,16 @@ def export_flow_characteristics( ): """ Export Flow Characteristics data to text file in CSV format - Parameter | Description | Type - ------------------------- | --------------------------------------------- | ----- - time_steps | Time step indices | List of Integer - injectors | Injector names | List of Strings - producers | Producer names | List of Strings - file_name | Export file name | Integer - minimum_communication | Minimum Communication, defaults to 0.0 | Integer - aquifer_cell_threshold | Aquifer Cell Threshold, defaults to 0.1 | Integer + **Parameters**:: + + Parameter | Description | Type + ------------------------- | --------------------------------------------- | ----- + time_steps | Time step indices | List of Integer + injectors | Injector names | List of Strings + producers | Producer names | List of Strings + file_name | Export file name | Integer + minimum_communication | Minimum Communication, defaults to 0.0 | Integer + aquifer_cell_threshold | Aquifer Cell Threshold, defaults to 0.1 | Integer """ if isinstance(time_steps, int): @@ -498,7 +509,7 @@ def available_properties(self, """Get a list of available properties Arguments: - property_type (str): string corresponding to property_type enum. Choices: + property_type (str): string corresponding to property_type enum. Choices:: - DYNAMIC_NATIVE - STATIC_NATIVE - SOURSIMRL diff --git a/docs/rips/instance.py b/docs/rips/instance.py index 1c85198985..be0b288c4c 100644 --- a/docs/rips/instance.py +++ b/docs/rips/instance.py @@ -225,20 +225,22 @@ class Instance: """ Set the export folder used for all export functions - Parameter | Description | Type - ---------------- | -------------------------------------------- | ----- - export_type | String specifying what to export | String - path | Path to folder | String - create_folder | Create folder if it doesn't exist? | Boolean + **Parameters**:: - ##### Enum export_type + Parameter | Description | Type + ---------------- | -------------------------------------------- | ----- + export_type | String specifying what to export | String + path | Path to folder | String + create_folder | Create folder if it doesn't exist? | Boolean - Option | Description - --------------- | ------------ - "COMPLETIONS" | - "SNAPSHOTS" | - "PROPERTIES" | - "STATISTICS" | + **Enum export_type**:: + + Option | Description + --------------- | ------------ + "COMPLETIONS" | + "SNAPSHOTS" | + "PROPERTIES" | + "STATISTICS" | """ return self.__execute_command(setExportFolder=Cmd.SetExportFolderRequest( @@ -248,10 +250,13 @@ class Instance: """ Set the main window size in pixels - Parameter | Description | Type - --------- | ---------------- | ----- - width | Width in pixels | Integer - height | Height in pixels | Integer + **Parameters**:: + + Parameter | Description | Type + --------- | ---------------- | ----- + width | Width in pixels | Integer + height | Height in pixels | Integer + """ return self.__execute_command(setMainWindowSize=Cmd.SetWindowSizeParams( width=width, height=height)) @@ -260,10 +265,12 @@ class Instance: """ Set the plot window size in pixels - Parameter | Description | Type - --------- | ---------------- | ----- - width | Width in pixels | Integer - height | Height in pixels | Integer + **Parameters**:: + + Parameter | Description | Type + --------- | ---------------- | ----- + width | Width in pixels | Integer + height | Height in pixels | Integer """ return self.__execute_command(setPlotWindowSize=Cmd.SetWindowSizeParams( width=width, height=height)) diff --git a/docs/rips/view.py b/docs/rips/view.py index fd5418e8c3..8afab04cbe 100644 --- a/docs/rips/view.py +++ b/docs/rips/view.py @@ -14,7 +14,7 @@ def apply_cell_result(self, result_type, result_variable): """Apply a regular cell result Arguments: - result_type (str): String representing the result category. The valid values are + result_type (str): String representing the result category. The valid values are:: - DYNAMIC_NATIVE - STATIC_NATIVE - SOURSIMRL @@ -39,21 +39,23 @@ def apply_flow_diagnostics_cell_result( producers=None): """Apply a flow diagnostics cell result - Parameter | Description | Type - ------------------- | ------------------------------------------------------ | ----- - result_variable | String representing the result value | String - selection_mode | String specifying which tracers to select | String - injectors | List of injector names, used by 'FLOW_TR_BY_SELECTION' | String List - producers | List of injector names, used by 'FLOW_TR_BY_SELECTION' | String List + **Parameters**:: - ##### Enum compdat_export + Parameter | Description | Type + ------------------- | ------------------------------------------------------ | ----- + result_variable | String representing the result value | String + selection_mode | String specifying which tracers to select | String + injectors | List of injector names, used by 'FLOW_TR_BY_SELECTION' | String List + producers | List of injector names, used by 'FLOW_TR_BY_SELECTION' | String List - Option | Description - ------------------------| ------------ - "TOF" | Time of flight - "Fraction" | Fraction - "MaxFractionTracer" | Max Fraction Tracer - "Communication" | Communication + **Enum compdat_export**:: + + Option | Description + ------------------------| ------------ + "TOF" | Time of flight + "Fraction" | Fraction + "MaxFractionTracer" | Max Fraction Tracer + "Communication" | Communication """ if injectors is None: @@ -89,27 +91,29 @@ def export_sim_well_fracture_completions(self, time_step, compdat_export): """Export fracture completions for simulation wells - Parameter | Description | Type - ----------------------------| ------------------------------------------------ | ----- - time_step | Time step to export for | Integer - simulation_well_names | List of simulation well names | List - file_split | Controls how export data is split into files | String enum - compdat_export | Compdat export type | String enum + **Parameters**:: - ##### Enum file_split + Parameter | Description | Type + ----------------------------| ------------------------------------------------ | ----- + time_step | Time step to export for | Integer + simulation_well_names | List of simulation well names | List + file_split | Controls how export data is split into files | String enum + compdat_export | Compdat export type | String enum - Option | Description - ----------------------------------- | ------------ - "UNIFIED_FILE" Default Option| A single file with all transmissibilities - "SPLIT_ON_WELL" | One file for each well transmissibilities - "SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well + **Enum file_split**:: - ##### Enum compdat_export + Option | Description + ----------------------------------- | ------------ + "UNIFIED_FILE" Default Option| A single file with all transmissibilities + "SPLIT_ON_WELL" | One file for each well transmissibilities + "SPLIT_ON_WELL_AND_COMPLETION_TYPE" | One file for each completion type for each well - Option | Description - -----------------------------------------| ------------ - "TRANSMISSIBILITIES"Default Option| Direct export of transmissibilities - "WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include export of WPIMULT + **Enum compdat_export**:: + + Option | Description + -----------------------------------------| ------------ + "TRANSMISSIBILITIES"Default Option| Direct export of transmissibilities + "WPIMULT_AND_DEFAULT_CONNECTION_FACTORS" | Include export of WPIMULT """ if isinstance(simulation_well_names, str):