Skip to content

Commit

Permalink
Make sure extra line break is present to be able to produce correct doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@magnesj
magnesj committed May 4, 2021
1 parent 638a16a commit 041c3b0
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
44 changes: 43 additions & 1 deletion docs/rips/generated/generated_classes.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ def __init__(self, pb2_object=None, channel=None):

def views(self):
"""All Eclipse Views in the case
Returns:
List of EclipseView
"""
Expand Down Expand Up @@ -111,6 +112,7 @@ def __init__(self, pb2_object=None, channel=None):
def add_property_scaling(self, formation=None, facies=None, property=None, scale=None):
"""
Add Elastic Property Scaling
Arguments:
formation (str): Formation
facies (str): Facies
Expand All @@ -124,6 +126,7 @@ def add_property_scaling(self, formation=None, facies=None, property=None, scale

def property_scaling_collection(self):
"""PropertyScalingCollection
Returns:
ElasticPropertyScalingCollection
"""
Expand Down Expand Up @@ -168,6 +171,7 @@ def __init__(self, pb2_object=None, channel=None):

def elastic_property_scalings(self):
"""Elastic Property Scalings
Returns:
List of ElasticPropertyScaling
"""
Expand All @@ -184,7 +188,7 @@ class FaciesProperties(PdmObjectBase):
__custom_init__ = None #: Assign a custom init routine to be run at __init__

def __init__(self, pb2_object=None, channel=None):
self.color_legend = "ColorLegend:1446460090704"
self.color_legend = "ColorLegend:1682353580928"
self.file_path = ""
self.properties_table = ""
PdmObjectBase.__init__(self, pb2_object, channel)
Expand All @@ -193,6 +197,7 @@ def __init__(self, pb2_object=None, channel=None):

def facies_definition(self):
"""
Returns:
EclipseResult
"""
Expand Down Expand Up @@ -226,6 +231,7 @@ def __init__(self, pb2_object=None, channel=None):
def available_addresses(self, ):
"""
Arguments:
Returns:
Expand All @@ -237,6 +243,7 @@ def available_addresses(self, ):
def available_time_steps(self, ):
"""
Arguments:
Returns:
Expand All @@ -248,6 +255,7 @@ def available_time_steps(self, ):
def resample_values(self, address=None, resampling_period=None):
"""
Arguments:
address (str): Formatted address specifying the summary vector
resampling_period (str): Resampling Period
Expand All @@ -260,6 +268,7 @@ def resample_values(self, address=None, resampling_period=None):
def summary_vector_values(self, address=None):
"""
Get all values for a summary vector
Arguments:
address (str): Formatted address specifying the summary vector
Returns:
Expand Down Expand Up @@ -344,6 +353,7 @@ def __init__(self, pb2_object=None, channel=None):

def grid_statistics_plots(self):
"""
Returns:
List of GridStatisticsPlot
"""
Expand Down Expand Up @@ -391,6 +401,7 @@ def __init__(self, pb2_object=None, channel=None):

def well_path_geometry(self):
"""Trajectory
Returns:
WellPathGeometry
"""
Expand All @@ -415,6 +426,7 @@ def __init__(self, pb2_object=None, channel=None):

def facies_definition(self):
"""
Returns:
EclipseResult
"""
Expand All @@ -436,6 +448,7 @@ def __init__(self, pb2_object=None, channel=None):

def views(self):
"""All GeoMech Views in the Case
Returns:
List of GeoMechView
"""
Expand All @@ -457,6 +470,7 @@ def __init__(self, pb2_object=None, channel=None):
def import_summary_case(self, file_name=None):
"""
Import Summary Case
Arguments:
file_name (str):
Returns:
Expand All @@ -468,6 +482,7 @@ def import_summary_case(self, file_name=None):
def summary_case(self, case_id=None):
"""
Find Summary Case
Arguments:
case_id (int):
Returns:
Expand All @@ -479,6 +494,7 @@ def summary_case(self, case_id=None):
def surface_folder(self, folder_name=None):
"""
Get Surface Folder
Arguments:
folder_name (str):
Returns:
Expand Down Expand Up @@ -516,6 +532,7 @@ def __init__(self, pb2_object=None, channel=None):

def cell_result(self):
"""Cell Result
Returns:
CellColors
"""
Expand All @@ -525,6 +542,7 @@ def cell_result(self):

def cell_result_data(self):
"""Current Eclipse Cell Result
Returns:
str
"""
Expand All @@ -533,6 +551,7 @@ def cell_result_data(self):

def set_cell_result_data(self, values):
"""Set Current Eclipse Cell Result
Arguments:
values (str): data
"""
Expand Down Expand Up @@ -597,6 +616,7 @@ def __init__(self, pb2_object=None, channel=None):

def cell_filters(self):
"""Filters
Returns:
List of CellFilter
"""
Expand Down Expand Up @@ -728,6 +748,7 @@ def __init__(self, pb2_object=None, channel=None):
def export_to_file(self, directory_path=None):
"""
Export StimPlan Model Plot to File
Arguments:
directory_path (str): Directory Path
Returns:
Expand All @@ -747,6 +768,7 @@ def __init__(self, pb2_object=None, channel=None):
def new_stim_plan_model(self, well_path=None, measured_depth=None, stim_plan_model_template=None):
"""
Create a new StimPlan Model
Arguments:
well_path (WellPathBase): Well Path
measured_depth (float): Measured Depth
Expand All @@ -759,6 +781,7 @@ def new_stim_plan_model(self, well_path=None, measured_depth=None, stim_plan_mod

def stim_plan_models(self):
"""
Returns:
List of StimPlanModel
"""
Expand Down Expand Up @@ -839,6 +862,7 @@ def __init__(self, pb2_object=None, channel=None):
def new_stim_plan_model_plot(self, stim_plan_model=None):
"""
Create a new StimPlan Model
Arguments:
stim_plan_model (StimPlanModel): StimPlan Model
Returns:
Expand All @@ -849,6 +873,7 @@ def new_stim_plan_model_plot(self, stim_plan_model=None):

def stim_plan_model_plots(self):
"""
Returns:
List of StimPlanModelPlot
"""
Expand Down Expand Up @@ -918,6 +943,7 @@ def __init__(self, pb2_object=None, channel=None):

def elastic_properties(self):
"""Elastic Properties
Returns:
ElasticProperties
"""
Expand All @@ -927,6 +953,7 @@ def elastic_properties(self):

def facies_initial_pressure_configs(self):
"""Facies Initial Pressure Configs
Returns:
List of FaciesInitialPressureConfig
"""
Expand All @@ -935,6 +962,7 @@ def facies_initial_pressure_configs(self):

def facies_properties(self):
"""Facies Properties
Returns:
FaciesProperties
"""
Expand All @@ -944,6 +972,7 @@ def facies_properties(self):

def non_net_layers(self):
"""Non-Net Layers
Returns:
NonNetLayers
"""
Expand All @@ -953,6 +982,7 @@ def non_net_layers(self):

def pressure_table(self):
"""Pressure Table
Returns:
PressureTable
"""
Expand All @@ -971,6 +1001,7 @@ def __init__(self, pb2_object=None, channel=None):
def new_stim_plan_model_template(self, eclipse_case=None, time_step=None, facies_properties_file_path=None, elastic_properties_file_path=None):
"""
Create a new StimPlan Model Template
Arguments:
eclipse_case (RimReservoir): Eclipse Case
time_step (int): Time Step
Expand All @@ -984,6 +1015,7 @@ def new_stim_plan_model_template(self, eclipse_case=None, time_step=None, facies

def stim_plan_model_templates(self):
"""StimPlan Model Templates
Returns:
List of StimPlanModelTemplate
"""
Expand Down Expand Up @@ -1051,6 +1083,7 @@ def __init__(self, pb2_object=None, channel=None):
def new_summary_plot(self, summary_cases=[], ensemble=None, address=None):
"""
Create a new Summary Plot
Arguments:
summary_cases (List of SummaryCase): Summary Cases
ensemble (SummaryCaseSubCollection): Ensemble
Expand Down Expand Up @@ -1100,6 +1133,7 @@ def __init__(self, pb2_object=None, channel=None):
def add_folder(self, folder_name=None):
"""
Add a new surface folder
Arguments:
folder_name (str): New surface folder name
Returns:
Expand All @@ -1111,6 +1145,7 @@ def add_folder(self, folder_name=None):
def import_surface(self, file_name=None):
"""
Import a new surface from file
Arguments:
file_name (str): Filename to import surface from
Returns:
Expand All @@ -1121,6 +1156,7 @@ def import_surface(self, file_name=None):

def sub_collections(self):
"""Surfaces
Returns:
List of SurfaceCollection
"""
Expand All @@ -1129,6 +1165,7 @@ def sub_collections(self):

def surfaces_field(self):
"""Surfaces
Returns:
List of SurfaceInterface
"""
Expand Down Expand Up @@ -1221,6 +1258,7 @@ def __init__(self, pb2_object=None, channel=None):

def parameters(self):
"""Well Bore Stability Parameters
Returns:
WbsParameters
"""
Expand Down Expand Up @@ -1267,6 +1305,7 @@ def __init__(self, pb2_object=None, channel=None):

def auto_generated_target(self):
"""Auto Generated Target
Returns:
WellPathTarget
"""
Expand All @@ -1276,6 +1315,7 @@ def auto_generated_target(self):

def well_path_targets(self):
"""Well Targets
Returns:
List of WellPathTarget
"""
Expand All @@ -1301,6 +1341,7 @@ def __init__(self, pb2_object=None, channel=None):

def child_well_paths(self):
"""Child Well Paths
Returns:
List of WellPath
"""
Expand All @@ -1309,6 +1350,7 @@ def child_well_paths(self):

def valve(self):
"""Branch Outlet Valve
Returns:
WellPathValve
"""
Expand Down
1 change: 1 addition & 0 deletions docs/rips/gridcasegroup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ def views(self):
@add_method(GridCaseGroup)
def view(self, view_id):
"""Get a particular view belonging to a case group by providing view id
Arguments:
id(int): view id
Expand Down

0 comments on commit 041c3b0

Please sign in to comment.