pytuflow.TCF.soils_file

Contents

pytuflow.TCF.soils_file#

TCF.soils_file(context=None)#

Returns the SoilDatabase database instance.

If more than one SoilDatabase database instance exists, a Context object must be provided to resolve to the correct SoilDatabase.

Parameters:

context (Context, optional) – A context object to resolve the correct SoilDatabase database instance. Not required unless more than one SoilDatabase database instance exists.

Returns:

The SoilDatabase database instance.

Return type:

SoilDatabase

Raises:

  • KeyError – If the SoilDatabase database is not found in the control file.

  • ValueError – If more than one SoilDatabase database is found and no context is provided to resolve the correct, or if the context does not resolve into a single SoilDatabase database.

Example

>>> tcf = ... # assuming is an instance of TCF
>>> soils_file = tcf.soils_file()
Contents