Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add attributes to docstring #295

Merged
merged 1 commit into from
Mar 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/pygef/bore.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,22 @@

@dataclass
class BoreData:
"""
The Bore dataclass holds the information from the BHRgt object.

Attributes:
bro_id (str | None): BRO ID of the BHRgt.
research_report_date (date): research report date
delivered_location (Location): delivered location in EPSG:28992 - RD new
standardized_location (Location | None): standardized location in EPSG:4326 - WGS 84
delivered_vertical_position_offset (float | None): delivered vertical position offset
delivered_vertical_position_datum (str): research delivered vertical position datum
delivered_vertical_position_reference_point (str): delivered vertical position reference point
bore_rock_reached (bool): bore rock reached
final_bore_depth (float): final bore depth
data (pl.DataFrame): DataFrame
"""

# dispatch_document bhrgt
bro_id: str | None
research_report_date: date
Expand Down
43 changes: 43 additions & 0 deletions src/pygef/cpt.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,49 @@ class QualityClass(Enum):

@dataclass
class CPTData:
"""
The CPT dataclass holds the information from the CPT object.

Attributes:
bro_id (str | None): BRO ID of the CPT.
research_report_date (date): research report date
delivered_location (Location): delivered location in `EPSG:28992 - RD new`
standardized_location (Location | None): standardized location in `EPSG:4326 - WGS 84`
delivered_vertical_position_offset (float | None): delivered vertical position offset
delivered_vertical_position_datum (str): research delivered vertical position datum
delivered_vertical_position_reference_point (str): delivered vertical position reference point
cpt_standard (str | None): cpt standard
dissipationtest_performed (bool | None): dissipationtest performed
quality_class (QualityClass): quality class
predrilled_depth (float): predrilled depth
final_depth (float): final depth
cpt_description (str): cpt description
cpt_type (str): cpt type
cone_surface_area (int): cone_surface_area
cone_diameter (int | None): cone_diameter
cone_surface_quotient (float | None): cone_surface_quotient
cone_to_friction_sleeve_distance (int | None): cone_to_friction_sleeve_distance
cone_to_friction_sleeve_surface_area (int | None): cone_to_friction_sleeve_surface_area
cone_to_friction_sleeve_surface_quotient (float | None): cone_to_friction_sleeve_surface_quotient
zlm_cone_resistance_before (float): zlm_cone_resistance_before
zlm_cone_resistance_after (float): zlm_cone_resistance_after
zlm_inclination_ew_before (int | None): zlm_inclination_ew_before
zlm_inclination_ew_after (int | None): zlm_inclination_ew_after
zlm_inclination_ns_before (int | None): zlm_inclination_ns_before
zlm_inclination_ns_after (int | None): zlm_inclination_ns_after
zlm_inclination_resultant_before (int | None): zlm_inclination_resultant_before
zlm_inclination_resultant_after (int | None): zlm_inclination_resultant_after
zlm_local_friction_before (float | None): zlm_local_friction_before
zlm_local_friction_after (float | None): zlm_local_friction_after
zlm_pore_pressure_u1_before (float | None): zlm_pore_pressure_u1_before
zlm_pore_pressure_u2_before (float | None): zlm_pore_pressure_u2_before
zlm_pore_pressure_u3_before (float | None): zlm_pore_pressure_u3_before
zlm_pore_pressure_u1_after (float | None): zlm_pore_pressure_u1_after
zlm_pore_pressure_u2_after (float | None): zlm_pore_pressure_u2_after
zlm_pore_pressure_u3_after (float | None): zlm_pore_pressure_u3_after
data (pl.DataFrame): DataFrame
"""

# dispatch_document cpt
bro_id: str | None
research_report_date: date
Expand Down