Index

Bases: BaseModel

Map a 1-based file column to a registered field name.

Fields:

• column (int)
• field (str)
• factor (float | None)

column: int

factor: float | None = 1.0

field: str

Mixin that reads and writes AGS 4 site-investigation files.

Methods:

from_ags(source: Any) -> T

write_ags(
    path: Any, dict_version: Literal["4.2"] = "4.2"
) -> None

Mixin that loads CPT traces from a CPeT-IT Excel export.

Methods:

from_cpetit_excel(
    source: Any,
    exported_as: Literal["normal", "custom"] = "normal",
) -> T

Mixin adding cross-section DXF export to SiteInvestigation.

Methods:

cross_section(
    stations: list[CrossSectionStation] | None = None,
    *,
    vertical: Literal["depth", "elevation"] = "elevation",
    **kwargs: Any
) -> CrossSection

write_cross_section_dxf(
    path: str | Path,
    *,
    stations: list[CrossSectionStation] | None = None,
    vertical: Literal["depth", "elevation"] = "elevation",
    **kwargs: Any
) -> None

Mixin that writes a DXF plan of in-situ test locations.

Methods:

write_dxf_map(path: Any) -> None

Mixin that reads and writes site-investigation Excel workbooks.

Methods:

from_excel(source: Any, project_id: str) -> T

write_excel(
    path: Any,
    as_labels: bool = True,
    include_calculations: bool = False,
) -> None

Mixin that writes a KML map of in-situ test locations.

Methods:

write_kml_map(path: Any) -> None

Mixin that loads Next-Generation Liquefaction AGS/CSV files.

Methods:

from_next_generation_liquefaction_ags(source: Any) -> T

Bases: Model

Build a site investigation from user CSV/Excel column assignments.

Fields:

• delimiter (Literal[*list(keys()),])
• first_line (int)
• import_all_sheets (bool)
• data_type (Literal['BORH', 'CPT', 'DMT', 'IST'])
• columns_assignments (list[AssignmentItem])

columns_assignments: list[AssignmentItem] = [
    AssignmentItem(column=1, field="depth", factor=1.0)
]

data_type: Literal['BORH', 'CPT', 'DMT', 'IST'] = 'CPT'

delimiter: Literal[*list(keys()),] = 'comma (,)'

first_line: int = 2

import_all_sheets: bool = True

available_datasets() -> list[str]

handle_files(
    files: list[str | Path],
    file_type: Literal["text", "excel"] = "text",
) -> SiteInvestigation

load_dataset(
    dataset_id: str,
) -> InSituTestsLoadUserDefinedData