Skip to content

Commit d042827

Browse files
actions-useractions-user
committed
Update dev version documentation
1 parent 25cc7c9 commit d042827

6 files changed

+8
-8
lines changed

‎dev/dev/_autosummary/geolib.models.dgeoflow.dgeoflow_model.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@
360360

361361
<dl class="py attribute">
362362
<dt class="sig sig-object py" id="geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.model_fields">
363-
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'current_calculation_index':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'current_id':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=-1),</span> <span class="pre">'current_scenario':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=-1),</span> <span class="pre">'current_scenario_index':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'current_stage_index':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'datastructure':</span> <span class="pre">FieldInfo(annotation=DGeoFlowStructure,</span> <span class="pre">required=False,</span> <span class="pre">default=DGeoFlowStructure(soillayers=[SoilLayerCollection(ContentVersion='2',</span> <span class="pre">Id='14',</span> <span class="pre">SoilLayers=[])],</span> <span class="pre">soils=SoilCollection(ContentVersion='2',</span> <span class="pre">Soils=[PersistableSoil(Code='H_Aa_ht_new',</span> <span class="pre">Id='2',</span> <span class="pre">Name='Embankment</span> <span class="pre">new',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_Aa_ht_old',</span> <span class="pre">Id='3',</span> <span class="pre">Name='Embankment</span> <span class="pre">old',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_Rk_k_shallow',</span> <span class="pre">Id='4',</span> <span class="pre">Name='Clay,</span> <span class="pre">shallow',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_Rk_k_deep',</span> <span class="pre">Id='5',</span> <span class="pre">Name='Clay,</span> <span class="pre">deep',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_Rk_ko',</span> <span class="pre">Id='6',</span> <span class="pre">Name='Organic</span> <span class="pre">clay',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_vhv_v',</span> <span class="pre">Id='7',</span> <span class="pre">Name='Peat,</span> <span class="pre">shallow',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_vbv_v',</span> <span class="pre">Id='8',</span> <span class="pre">Name='Peat,</span> <span class="pre">deep',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='Sand',</span> <span class="pre">Id='9',</span> <span class="pre">Name='Sand',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=30.0,</span> <span class="pre">VerticalPermeability=30.0),</span> <span class="pre">PersistableSoil(Code='P_Rk_k&amp;s',</span> <span class="pre">Id='10',</span> <span class="pre">Name='Clay</span> <span class="pre">with</span> <span class="pre">silt',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.1,</span> <span class="pre">VerticalPermeability=0.1),</span> <span class="pre">PersistableSoil(Code='H_Ro_z&amp;k',</span> <span class="pre">Id='11',</span> <span class="pre">Name='Sand</span> <span class="pre">with</span> <span class="pre">clay',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=1.0,</span> <span class="pre">VerticalPermeability=1.0),</span> <span class="pre">PersistableSoil(Code='Sand,</span> <span class="pre">less</span> <span class="pre">permeable',</span> <span class="pre">Id='12',</span> <span class="pre">Name='Sand,</span> <span class="pre">less</span> <span class="pre">permeable',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=15.0,</span> <span class="pre">VerticalPermeability=15.0),</span> <span class="pre">PersistableSoil(Code='Sand,</span> <span class="pre">permeable',</span> <span class="pre">Id='13',</span> <span class="pre">Name='Sand,</span> <span class="pre">permeable',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=45.0,</span> <span class="pre">VerticalPermeability=45.0)]),</span> <span class="pre">soilvisualizations=SoilVisualisation(ContentVersion='2',</span> <span class="pre">SoilVisualizations=[]),</span> <span class="pre">projectinfo=ProjectInfo(Analyst='',</span> <span class="pre">ApplicationCreated='',</span> <span class="pre">ApplicationModified='',</span> <span class="pre">ContentVersion='2',</span> <span class="pre">Created=datetime.date(2024,</span> <span class="pre">9,</span> <span class="pre">10),</span> <span class="pre">CrossSection='',</span> <span class="pre">Date=datetime.date(2024,</span> <span class="pre">9,</span> <span class="pre">10),</span> <span class="pre">IsDataValidated=False,</span> <span class="pre">LastModified=datetime.date(2024,</span> <span class="pre">9,</span> <span class="pre">10),</span> <span class="pre">LastModifier='GEOLib',</span> <span class="pre">Path='',</span> <span class="pre">Project='',</span> <span class="pre">Remarks='Created</span> <span class="pre">with</span> <span class="pre">GEOLib</span> <span class="pre">2.5.0'),</span> <span class="pre">geometries=[Geometry(ContentVersion='2',</span> <span class="pre">Id='1',</span> <span class="pre">Layers=[])],</span> <span class="pre">boundary_conditions=[BoundaryConditionCollection(ContentVersion='2',</span> <span class="pre">Id='15',</span> <span class="pre">BoundaryConditions=[])],</span> <span class="pre">scenarios=[Scenario(ContentVersion='2',</span> <span class="pre">Id='0',</span> <span class="pre">Label='Scenario</span> <span class="pre">1',</span> <span class="pre">Notes=None,</span> <span class="pre">GeometryId='1',</span> <span class="pre">SoilLayersId='14',</span> <span class="pre">Stages=[PersistableStage(Label='Stage</span> <span class="pre">1',</span> <span class="pre">Notes=None,</span> <span class="pre">BoundaryConditionCollectionId='15')],</span> <span class="pre">Calculations=[PersistableCalculation(Label='Calculation</span> <span class="pre">1',</span> <span class="pre">Notes=None,</span> <span class="pre">CalculationType=&lt;CalculationTypeEnum.GROUNDWATER_FLOW:</span> <span class="pre">'GroundwaterFlow'&gt;,</span> <span class="pre">CriticalHeadId=None,</span> <span class="pre">CriticalHeadSearchSpace=PersistableCriticalHeadSearchSpace(MinimumHeadLevel=0.0,</span> <span class="pre">MaximumHeadLevel=1.0,</span> <span class="pre">StepSize=0.1),</span> <span class="pre">PipeTrajectory=None,</span> <span class="pre">MeshPropertiesId='16',</span> <span class="pre">ResultsId=None)])],</span> <span class="pre">mesh_properties=[MeshProperty(ContentVersion='2',</span> <span class="pre">Id='16',</span> <span class="pre">MeshProperties=[])],</span> <span class="pre">groundwater_flow_results=[],</span> <span class="pre">pipe_length_results=[],</span> <span class="pre">critical_head_results=[])),</span> <span class="pre">'filename':</span> <span class="pre">FieldInfo(annotation=Union[Path,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None)}</span></em><a class="headerlink" href="#geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.model_fields" title="Link to this definition"></a></dt>
363+
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'current_calculation_index':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'current_id':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=-1),</span> <span class="pre">'current_scenario':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=-1),</span> <span class="pre">'current_scenario_index':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'current_stage_index':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'datastructure':</span> <span class="pre">FieldInfo(annotation=DGeoFlowStructure,</span> <span class="pre">required=False,</span> <span class="pre">default=DGeoFlowStructure(soillayers=[SoilLayerCollection(ContentVersion='2',</span> <span class="pre">Id='14',</span> <span class="pre">SoilLayers=[])],</span> <span class="pre">soils=SoilCollection(ContentVersion='2',</span> <span class="pre">Soils=[PersistableSoil(Code='H_Aa_ht_new',</span> <span class="pre">Id='2',</span> <span class="pre">Name='Embankment</span> <span class="pre">new',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_Aa_ht_old',</span> <span class="pre">Id='3',</span> <span class="pre">Name='Embankment</span> <span class="pre">old',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_Rk_k_shallow',</span> <span class="pre">Id='4',</span> <span class="pre">Name='Clay,</span> <span class="pre">shallow',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_Rk_k_deep',</span> <span class="pre">Id='5',</span> <span class="pre">Name='Clay,</span> <span class="pre">deep',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_Rk_ko',</span> <span class="pre">Id='6',</span> <span class="pre">Name='Organic</span> <span class="pre">clay',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_vhv_v',</span> <span class="pre">Id='7',</span> <span class="pre">Name='Peat,</span> <span class="pre">shallow',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='H_vbv_v',</span> <span class="pre">Id='8',</span> <span class="pre">Name='Peat,</span> <span class="pre">deep',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.01,</span> <span class="pre">VerticalPermeability=0.01),</span> <span class="pre">PersistableSoil(Code='Sand',</span> <span class="pre">Id='9',</span> <span class="pre">Name='Sand',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=30.0,</span> <span class="pre">VerticalPermeability=30.0),</span> <span class="pre">PersistableSoil(Code='P_Rk_k&amp;s',</span> <span class="pre">Id='10',</span> <span class="pre">Name='Clay</span> <span class="pre">with</span> <span class="pre">silt',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=0.1,</span> <span class="pre">VerticalPermeability=0.1),</span> <span class="pre">PersistableSoil(Code='H_Ro_z&amp;k',</span> <span class="pre">Id='11',</span> <span class="pre">Name='Sand</span> <span class="pre">with</span> <span class="pre">clay',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=1.0,</span> <span class="pre">VerticalPermeability=1.0),</span> <span class="pre">PersistableSoil(Code='Sand,</span> <span class="pre">less</span> <span class="pre">permeable',</span> <span class="pre">Id='12',</span> <span class="pre">Name='Sand,</span> <span class="pre">less</span> <span class="pre">permeable',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=15.0,</span> <span class="pre">VerticalPermeability=15.0),</span> <span class="pre">PersistableSoil(Code='Sand,</span> <span class="pre">permeable',</span> <span class="pre">Id='13',</span> <span class="pre">Name='Sand,</span> <span class="pre">permeable',</span> <span class="pre">Notes='',</span> <span class="pre">HorizontalPermeability=45.0,</span> <span class="pre">VerticalPermeability=45.0)]),</span> <span class="pre">soilvisualizations=SoilVisualisation(ContentVersion='2',</span> <span class="pre">SoilVisualizations=[]),</span> <span class="pre">projectinfo=ProjectInfo(Analyst='',</span> <span class="pre">ApplicationCreated='',</span> <span class="pre">ApplicationModified='',</span> <span class="pre">ContentVersion='2',</span> <span class="pre">Created=datetime.date(2024,</span> <span class="pre">12,</span> <span class="pre">2),</span> <span class="pre">CrossSection='',</span> <span class="pre">Date=datetime.date(2024,</span> <span class="pre">12,</span> <span class="pre">2),</span> <span class="pre">IsDataValidated=False,</span> <span class="pre">LastModified=datetime.date(2024,</span> <span class="pre">12,</span> <span class="pre">2),</span> <span class="pre">LastModifier='GEOLib',</span> <span class="pre">Path='',</span> <span class="pre">Project='',</span> <span class="pre">Remarks='Created</span> <span class="pre">with</span> <span class="pre">GEOLib</span> <span class="pre">2.5.0'),</span> <span class="pre">geometries=[Geometry(ContentVersion='2',</span> <span class="pre">Id='1',</span> <span class="pre">Layers=[])],</span> <span class="pre">boundary_conditions=[BoundaryConditionCollection(ContentVersion='2',</span> <span class="pre">Id='15',</span> <span class="pre">BoundaryConditions=[])],</span> <span class="pre">scenarios=[Scenario(ContentVersion='2',</span> <span class="pre">Id='0',</span> <span class="pre">Label='Scenario</span> <span class="pre">1',</span> <span class="pre">Notes=None,</span> <span class="pre">GeometryId='1',</span> <span class="pre">SoilLayersId='14',</span> <span class="pre">Stages=[PersistableStage(Label='Stage</span> <span class="pre">1',</span> <span class="pre">Notes=None,</span> <span class="pre">BoundaryConditionCollectionId='15')],</span> <span class="pre">Calculations=[PersistableCalculation(Label='Calculation</span> <span class="pre">1',</span> <span class="pre">Notes=None,</span> <span class="pre">CalculationType=&lt;CalculationTypeEnum.GROUNDWATER_FLOW:</span> <span class="pre">'GroundwaterFlow'&gt;,</span> <span class="pre">CriticalHeadId=None,</span> <span class="pre">CriticalHeadSearchSpace=PersistableCriticalHeadSearchSpace(MinimumHeadLevel=0.0,</span> <span class="pre">MaximumHeadLevel=1.0,</span> <span class="pre">StepSize=0.1),</span> <span class="pre">PipeTrajectory=None,</span> <span class="pre">MeshPropertiesId='16',</span> <span class="pre">ResultsId=None)])],</span> <span class="pre">mesh_properties=[MeshProperty(ContentVersion='2',</span> <span class="pre">Id='16',</span> <span class="pre">MeshProperties=[])],</span> <span class="pre">groundwater_flow_results=[],</span> <span class="pre">pipe_length_results=[],</span> <span class="pre">critical_head_results=[])),</span> <span class="pre">'filename':</span> <span class="pre">FieldInfo(annotation=Union[Path,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=None)}</span></em><a class="headerlink" href="#geolib.models.dgeoflow.dgeoflow_model.DGeoFlowModel.model_fields" title="Link to this definition"></a></dt>
364364
<dd><p>Metadata about the fields defined on the model,
365365
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
366366
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>

0 commit comments

Comments
 (0)