Skip to content

Data Connector Documentation

Documentation for the terrakit.terrakit module.

terrakit.terrakit

DataConnector

A class to manage data connectors.

Attributes:

Name Type Description
connector DataConnector

An instance of the connector class specified during initialization.
connector_type str

The type of data connector.
Example 
# Example usage:
from terrakit import DataConnector

dc = DataConnector(connector_type="sentinel_aws")
dc.connector.list_collections()

or

dc = DataConnector("sentinel_aws")
dc.connector.list_collections()
Source code in terrakit/terrakit.py 
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
class DataConnector:
    """
    A class to manage data connectors.

    Attributes:
        connector (DataConnector): An instance of the connector class specified during initialization.
        connector_type (str): The type of data connector.

    Example:
        ```python
        # Example usage:
        from terrakit import DataConnector

        dc = DataConnector(connector_type="sentinel_aws")
        dc.connector.list_collections()
        ```

        or

        ```python
        dc = DataConnector("sentinel_aws")
        dc.connector.list_collections()
        ```
    """

    def __init__(self, connector_type: str):
        """
        Initialize DataConnector with the specified connector type.

        Parameters:
            connector_type (str): The type of data connector to initialize.

        """
        logger.info(f"Initializing DataConnector with connector type: {connector_type}")
        try:
            connector_type = ConnectorType(connector_type=connector_type)
            self.connector = DataConnectorFactory.get_connector(
                connector_type=connector_type
            )
        except ValidationError as e:
            raise TerrakitValidationError(
                message=f"Invalid connector type: '{connector_type}'"
            ) from e
        self.connector_type: str = connector_type

DataConnectorFactory

A factory class for creating data connector objects.

Source code in terrakit/terrakit.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
class DataConnectorFactory:
    """
    A factory class for creating data connector objects.
    """

    @staticmethod
    def get_connector(connector_type: ConnectorType) -> Connector:
        """
        Create and return a data connector object based on the specified connector type.

        Parameters:
            connector_type (str): The type of data connector to create. Supported types are:
                - "sentinelhub"
                - "nasa_earthdata"
                - "sentinel_aws"

        Returns:
            object: An instance of the specified data connector class.

        Raises:
            ValueError: If an invalid connector type is provided.
        """
        if connector_type.connector_type == "sentinelhub":
            return SentinelHub()
        elif connector_type.connector_type == "nasa_earthdata":
            return NASA_EarthData()
        elif connector_type.connector_type == "sentinel_aws":
            return Sentinel_AWS()
        elif connector_type.connector_type == "IBMResearchSTAC":
            return IBMResearchSTAC()
        elif connector_type.connector_type == "TheWeatherCompany":
            return TheWeatherCompany()
        # -----> Include new connectors here < ------
        # elif connector_type == "<new_connector>"
        #   return NewConnectorClass()
        else:
            raise TerrakitValidationError(
                f"Invalid connector type: '{connector_type.connector_type}'"
            )

get_connector(connector_type: ConnectorType) -> Connector staticmethod

Create and return a data connector object based on the specified connector type.

Parameters:

Name Type Description Default
connector_type str

The type of data connector to create. Supported types are: - "sentinelhub" - "nasa_earthdata" - "sentinel_aws"

 required

Returns:

Name Type Description
object Connector

An instance of the specified data connector class.

Raises:

Type Description
ValueError

If an invalid connector type is provided.
Source code in terrakit/terrakit.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
@staticmethod
def get_connector(connector_type: ConnectorType) -> Connector:
    """
    Create and return a data connector object based on the specified connector type.

    Parameters:
        connector_type (str): The type of data connector to create. Supported types are:
            - "sentinelhub"
            - "nasa_earthdata"
            - "sentinel_aws"

    Returns:
        object: An instance of the specified data connector class.

    Raises:
        ValueError: If an invalid connector type is provided.
    """
    if connector_type.connector_type == "sentinelhub":
        return SentinelHub()
    elif connector_type.connector_type == "nasa_earthdata":
        return NASA_EarthData()
    elif connector_type.connector_type == "sentinel_aws":
        return Sentinel_AWS()
    elif connector_type.connector_type == "IBMResearchSTAC":
        return IBMResearchSTAC()
    elif connector_type.connector_type == "TheWeatherCompany":
        return TheWeatherCompany()
    # -----> Include new connectors here < ------
    # elif connector_type == "<new_connector>"
    #   return NewConnectorClass()
    else:
        raise TerrakitValidationError(
            f"Invalid connector type: '{connector_type.connector_type}'"
        )