Layouts

subsurfaceio.cross_section.layouts

Default column templates per in-situ test type.

Functions:

Name	Description
`borehole_template`	Strata plus combined N60 / fines panel (0–100).
`cpt_template`	Strata, fs (inverted), qt, and Ic (1–4, ref 2.6).
`default_template_for_test_type`	Return the layout template for `test_type`.
`dmt_template`	Strata, P0/P1/P2, and log-scaled material index.
`has_plot_column_to_right`	Return whether a plot column follows `columns[index]`.
`ist_template`	Shear-wave velocity steps-post profile.
`udt_template`	Strata-only placeholder for user-defined tests.

borehole_template() -> CrossSectionTemplate

Strata plus combined N60 / fines panel (0–100).

Returns:

Type	Description
`CrossSectionTemplate`	Default borehole column layout.

cpt_template() -> CrossSectionTemplate

Strata, fs (inverted), qt, and Ic (1–4, ref 2.6).

Returns:

Type	Description
`CrossSectionTemplate`	Default CPT column layout.

default_template_for_test_type(
    test_type: str,
    overrides: dict[str, CrossSectionTemplate],
) -> CrossSectionTemplate

Return the layout template for test_type.

Parameters:

Name	Type	Description	Default
`test_type`	`str`	In-situ test type code such as `CPT` or `BORH`.	required
`overrides`	`dict[str, CrossSectionTemplate]`	Per-type template replacements; an empty dict uses defaults.	required

Returns:

Type	Description
`CrossSectionTemplate`	Column layout for that test type, or an empty template when unknown.

dmt_template() -> CrossSectionTemplate

Strata, P0/P1/P2, and log-scaled material index.

Returns:

Type	Description
`CrossSectionTemplate`	Default DMT column layout.

has_plot_column_to_right(
    columns: list[ColumnSpec], index: int
) -> bool

Return whether a plot column follows columns[index].

Parameters:

Name	Type	Description	Default
`columns`	`list[ColumnSpec]`	Ordered template columns.	required
`index`	`int`	Index of the current column.	required

Returns:

Type	Description
`bool`	True if a plot column appears to the right of `index`.

ist_template() -> CrossSectionTemplate

Shear-wave velocity steps-post profile.

Returns:

Type	Description
`CrossSectionTemplate`	Default IST column layout.

udt_template() -> CrossSectionTemplate

Strata-only placeholder for user-defined tests.

Returns:

Type	Description
`CrossSectionTemplate`	Default UDT column layout.