User Guide#

The user guide covers all of geotech-pandas by topic area. Each of the subsections introduces a topic, and discusses how geotech-pandas approaches the problem, with many examples throughout.

The methods in geotech-pandas are designed to work on multiple points at the same time which effectively reduces the time required for routine tasks. However, most guides are demonstrated with DataFrame objects with only one point for brevity.

Note

In geotech-pandas, a point represents the point in which a borehole or a soil profile is located. For now, geotech-pandas is location-unaware so it is not required to supply geographic data in DataFrame objects. This may change in the future to support methods for plotting site maps and similar tasks.

Further information on any specific method can be obtained in the API Reference.

If you’re new to Pandas in general, it is recommended to make yourself familiar with it first by heading to the Pandas documentation.

How to read these guides#

In these guides, you will see input code inside code blocks such as,

import pandas as pd
import geotech_pandas
pd.DataFrame({'A': [1, 2, 3]})

or,

In [1]: import pandas as pd

In [2]: import geotech_pandas

In [3]: pd.DataFrame({'A': [1, 2, 3]})
Out[3]: 
   A
0  1
1  2
2  3

The first block is a standard python input, while in the second block, the In [x]: indicates that the input is inside a Jupyter notebook where x is the line number. In Jupyter notebooks, the last line is printed and plots are shown inline indicated by Out[x]:.

For example,

In [4]: a = 1

In [5]: a
Out[5]: 1

is equivalent to,

a = 1
print(a)

Guides#

Getting Started

Usage and Subaccessors