storage_retriever
Classes:
Name | Description |
---|---|
StorageRetriever |
Retriever API for pulling input data from the storage area. |
Attributes#
Classes#
StorageRetriever #
Bases: Retriever
Retriever API for pulling input data from the storage area.
Classes:
Name | Description |
---|---|
TransParameters |
|
Methods:
Name | Description |
---|---|
retrieve |
|
Attributes:
Name | Type | Description |
---|---|---|
parameters |
Optional[TransParameters]
|
|
Attributes#
Classes#
TransParameters #
Bases: BaseModel
Attributes:
Name | Type | Description |
---|---|---|
fetch_params |
Optional[GlobalFetchParams]
|
|
trans_params |
Optional[GlobalARMTransformParams]
|
|
Functions#
retrieve #
retrieve(
input_keys: List[str],
dataset_config: DatasetConfig,
storage: Optional[Storage] = None,
input_data_hook: Optional[
Callable[
[Dict[str, xr.Dataset]], Dict[str, xr.Dataset]
]
] = None,
**kwargs: Any
) -> xr.Dataset
Retrieves input data from the storage area.
Note that each input_key is expected to be formatted according to the following format:
e.g.,
"--datastream sgp.met.b0 --start 20230801 --end 20230901"
"--datastream sgp.met.b0 --start 20230801 --end 20230901 --location_id sgp --data_level b0"
This format allows the retriever to pull datastream data from the Storage API for the desired dates for each desired input source.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_keys
|
List[str]
|
A list of input keys formatted as described above. |
required |
dataset_config
|
DatasetConfig
|
The output dataset configuration. |
required |
storage
|
Storage
|
Instance of a Storage class used to fetch saved data. |
None
|
Returns:
Type | Description |
---|---|
Dataset
|
xr.Dataset: The retrieved dataset |
Source code in tsdat/io/retrievers/storage_retriever.py
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 64 65 66 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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
|