API Reference#

In geotech-pandas, various subaccessors provide scope-specific methods. These methods reside in separate namespaces within geotech.

Most methods include a Requires block, which lists the columns required for that specific method. Each listed column links to its corresponding entry in the Column Reference.

Requires:

If the required columns are missing from the DataFrame when calling a method, an error will be raised. This error message will also list the missing columns. By default, point_id and bottom are the minimum required columns. However, these two columns are generally not defined in the Requires block unless the method explicitly uses them (e.g., get_top()).

Accessor#

DataFrame.geotech

DataFrame accessor that provides namespaces to the various subaccessors in geotech-pandas.