/
fleet_utilisation_destination_breakdown.py
240 lines (185 loc) · 13.4 KB
/
fleet_utilisation_destination_breakdown.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Futilisation_destination_breakdown.ipynb)
"""
from typing import Any, Dict, List, Union
from datetime import datetime
from vortexasdk.endpoints.endpoints import (
FLEET_UTILISATION_DESTINATION_BREAKDOWN,
)
from vortexasdk.endpoints.reference_breakdown_result import (
ReferenceBreakdownResult,
)
from vortexasdk.api import ID
from vortexasdk.operations import Search
from vortexasdk.utils import convert_to_list, sts_param_value
from vortexasdk.api.shared_types import to_ISODate
class FleetUtilisationDestinationBreakdown(Search):
"""
Please note: you will require a subscription to our Freight module to access this endpoint.
"""
def __init__(self):
Search.__init__(self, FLEET_UTILISATION_DESTINATION_BREAKDOWN)
def search(
self,
breakdown_unit: str = None,
breakdown_size: int = None,
breakdown_geography: str = None,
filter_time_min: datetime = datetime(2019, 10, 1, 0),
filter_time_max: datetime = datetime(2019, 10, 1, 1),
unit: str = "b",
filter_activity: str = None,
filter_charterers: Union[ID, List[ID]] = None,
filter_destinations: Union[ID, List[ID]] = None,
filter_origins: Union[ID, List[ID]] = None,
filter_owners: Union[ID, List[ID]] = None,
filter_products: Union[ID, List[ID]] = None,
filter_vessels: Union[ID, List[ID]] = None,
filter_vessel_classes: Union[str, List[str]] = None,
filter_vessel_status: str = None,
filter_ship_to_ship: bool = None,
filter_charterer_exists: bool = None,
filter_vessel_age_min: int = None,
filter_vessel_age_max: int = None,
filter_vessel_dwt_min: int = None,
filter_vessel_dwt_max: int = None,
filter_vessel_scrubbers: str = "disabled",
filter_vessel_flags: Union[ID, List[ID]] = None,
filter_vessel_ice_class: Union[ID, List[ID]] = None,
filter_vessel_propulsion: Union[ID, List[ID]] = None,
exclude_origins: Union[ID, List[ID]] = None,
exclude_destinations: Union[ID, List[ID]] = None,
exclude_products: Union[ID, List[ID]] = None,
exclude_vessels: Union[ID, List[ID]] = None,
exclude_vessel_classes: Union[str, List[str]] = None,
exclude_charterers: Union[ID, List[ID]] = None,
exclude_owners: Union[ID, List[ID]] = None,
exclude_vessel_flags: Union[ID, List[ID]] = None,
exclude_vessel_ice_class: Union[ID, List[ID]] = None,
exclude_vessel_propulsion: Union[ID, List[ID]] = None,
) -> ReferenceBreakdownResult:
"""
Number of unique vessels by destination.
# Arguments
breakdown_unit: Units to aggregate upon. Must be one of the following: `'b'`, `'t'`, `'cbm'`, `'bpd'`, `'tpd'`, `'mpd'`.
breakdown_size: Number of top geographies to return.
breakdown_geography: Geography hierarchy of the destination to aggregate upon. Must be one of the following: `'berth'`, `'terminal'`, `'port'`,`'country'`, `'shipping_region'`,
`'region'`,`'trading_block'`,`'trading_region'`,`'trading_subregion'`,`'sts_zone'`,`'waypoint'`.
filter_activity: Movement activity on which to base the time filter. Must be one of: `'loading_state'`,
`'loading_start'`, `'loading_end'`, `'identified_for_loading_state'`, `'unloading_state'`, `'unloading_start'`,
`'unloading_end'`, `'unloaded_state'`, `'storing_state'`, `'storing_start'`, `'storing_end'`, `'transiting_state'`,
`'any_activity'`.
filter_time_min: The UTC start date of the time filter.
filter_time_max: The UTC end date of the time filter.
unit: Unit of measurement. Enter `'b'` for barrels or `'t'` for tonnes.
filter_charterers: A charterer ID, or list of charterer IDs to filter on.
filter_destinations: A geography ID, or list of geography IDs to filter on.
filter_origins: A geography ID, or list of geography IDs to filter on.
filter_owners: An corporation ID, or list of corporation IDs to filter on.
filter_products: A product ID, or list of product IDs to filter on.
filter_vessels: A vessel ID, or list of vessel IDs to filter on.
filter_vessel_classes: A vessel class, or list of vessel classes to filter on.
filter_vessel_status: The vessel status on which to base the filter. Enter `'vessel_status_ballast'` for ballast vessels, `'vessel_status_laden_known'` for laden vessels with known cargo (i.e. a type of cargo that Vortexa currently tracks) or `'vessel_status_laden_unknown'` for laden vessels with unknown cargo (i.e. a type of cargo that Vortexa currently does not track).
filter_vessel_age_min: A number between 1 and 100 (representing years).
filter_vessel_age_max: A number between 1 and 100 (representing years).
filter_vessel_dwt_min: A number representing minimum deadweight tonnage of a vessel.
filter_vessel_dwt_max: A number representing maximum deadweight tonnage of a vessel.
filter_vessel_scrubbers: Either inactive `'disabled'`, or included `'inc'` or excluded `'exc'`.
filter_vessel_flags: A geography ID, or list of geography IDs to filter on.
filter_vessel_ice_class: An attribute ID, or list of attribute IDs to filter on.
filter_vessel_propulsion: An attribute ID, or list of attribute IDs to filter on.
filter_charterer_exists: A boolean to include or exclude the records to those that have a charterer.
filter_ship_to_ship: A boolean to include or exclude the records to those that are involved in an STS.
exclude_origins: A geography ID, or list of geography IDs to exclude.
exclude_destinations: A geography ID, or list of geography IDs to exclude.
exclude_products: A product ID, or list of product IDs to exclude.
exclude_vessels: A vessel ID, or list of vessel IDs to exclude.
exclude_vessel_classes: A vessel class, or list of vessel classes to exclude.
exclude_charterers: A charterer ID, or list of charterer IDs to exclude.
exclude_owners: An owner ID, or list of owner IDs to exclude.
exclude_vessel_flags: A geography ID, or list of geography IDs to exclude.
exclude_vessel_ice_class: An attribute ID, or list of attribute IDs to exclude.
exclude_vessel_propulsion: An attribute ID, or list of attribute IDs to exclude.
# Returns
`ReferenceBreakdownResult`
# Example
_Top 5 countries by number of unique vessels by destination country breakdown, in the last quarter._
```python
>>> from vortexasdk import FleetUtilisationDestinationBreakdown, Vessels
>>> from datetime import datetime
>>> search_result = FleetUtilisationDestinationBreakdown().search(
... breakdown_geography='country',
... breakdown_size='5',
... filter_time_min=datetime(2020, 10, 18),
... filter_time_max=datetime(2021, 1, 18))
>>> df = search_result.to_df()
```
returns
| |key | label |value |count |
|-----:|:-----------------------------------------------------------------|:--------------|:-----------|-----:|
|0 | 934c47f36c16a58d68ef5e007e62a23f5f036ee3f3d1f5f85a48c572b90ad8b2 | China |3305 |16226 |
|1 | 50182d9d05051a6c8d24f0514d4ee828da6eaa29eacbb11cfe368f51526328ce | Japan |1248 |10683 |
|2 | 2d92cc08f22524dba59f6a7e340f132a9da0ce9573cca968eb8e3752ef17a963 | United States |2017 |6092 |
|3 | bcd7dddaf951959ebf6076a3a594b426a246d3bffe13339b10d04e45f222e011 | South Korea |1543 |4883 |
|4 | 3267ef2a83a749052c87e981f1bb12c6396acf590b4b1cd3316cf8f8c5aeb7bc | Malaysia |1539 |4495 |
"""
sts_filter = sts_param_value(filter_ship_to_ship)
crossfilters = {
"filter_ship_to_ship": sts_filter["x_filter"],
# if charterer toggle is True, apply cross filter
# else make it false
"filter_charterer_exists": filter_charterer_exists == True,
}
exclude_params: Dict[str, Any] = {
"filter_origins": convert_to_list(exclude_origins),
"filter_destinations": convert_to_list(exclude_destinations),
"filter_products": convert_to_list(exclude_products),
"filter_vessels": convert_to_list(exclude_vessels),
"filter_vessel_classes": convert_to_list(exclude_vessel_classes),
"filter_charterers": convert_to_list(exclude_charterers),
"filter_owners": convert_to_list(exclude_owners),
"filter_vessel_flags": convert_to_list(exclude_vessel_flags),
"filter_vessel_ice_class": convert_to_list(
exclude_vessel_ice_class
),
"filter_vessel_propulsion": convert_to_list(
exclude_vessel_propulsion
),
}
api_params: Dict[str, Any] = {
"breakdown_unit": breakdown_unit,
"breakdown_size": breakdown_size,
"breakdown_geography": breakdown_geography,
"filter_activity": filter_activity,
"filter_time_min": to_ISODate(filter_time_min),
"filter_time_max": to_ISODate(filter_time_max),
"unit": unit,
"filter_charterers": convert_to_list(filter_charterers),
"filter_owners": convert_to_list(filter_owners),
"filter_destinations": convert_to_list(filter_destinations),
"filter_origins": convert_to_list(filter_origins),
"filter_products": convert_to_list(filter_products),
"filter_vessels": convert_to_list(filter_vessels),
"filter_vessel_classes": convert_to_list(filter_vessel_classes),
"filter_vessel_status": filter_vessel_status,
"filter_vessel_age_min": filter_vessel_age_min,
"filter_vessel_age_max": filter_vessel_age_max,
"filter_vessel_dwt_min": filter_vessel_dwt_min,
"filter_vessel_dwt_max": filter_vessel_dwt_max,
"filter_vessel_scrubbers": filter_vessel_scrubbers,
"filter_vessel_flags": convert_to_list(filter_vessel_flags),
"filter_vessel_ice_class": convert_to_list(
filter_vessel_ice_class
),
"filter_vessel_propulsion": convert_to_list(
filter_vessel_propulsion
),
"crossfilters": crossfilters,
"exclude": exclude_params,
}
response = super().search_with_client(
response_type="breakdown", **api_params
)
return ReferenceBreakdownResult(
records=response["data"], reference=response["reference"]
)