geost.read_pickle#

geost.read_pickle(filepath: str | Path, **kwargs) → Any[source]#

Read pickled GeoST object (or any object) from file.

Parameters:

  • filepath (str | Path) – Path to pickle file to open.

  • **kwargs – pd.read_pickle kwargs. See relevant Pandas documentation.

Returns:

Returns the Python object that was stored in the pickle.

Return type:

Any

Examples

Any GeoST geost.base.Collection object can be stored as a pickle file:

>>> original_collection = geost.data.boreholes_usp()
>>> original_collection
BoreholeCollection:
# header = 67
>>> original_collection.to_pickle("./collection.pkl")

Reading the stored pickle using geost.read_pickle returns the stored collection:

>>> collection = geost.read_pickle("./collection.pkl")
>>> collection
BoreholeCollection:
# header = 67