/
vessel_class_breakdown.py
275 lines (215 loc) · 15.3 KB
/
vessel_class_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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Fvessel_class_breakdown.ipynb)
"""
from typing import Any, Dict, List, Union
from datetime import datetime
from vortexasdk.api.shared_types import Tag, to_ISODate
from vortexasdk.endpoints.reference_breakdown_result import (
ReferenceBreakdownResult,
)
from vortexasdk.api import ID
from vortexasdk.endpoints.endpoints import VESSEL_CLASS_BREAKDOWN_RESOURCE
from vortexasdk.logger import get_logger
from vortexasdk.operations import Search
from vortexasdk.utils import convert_to_list
logger = get_logger(__name__)
class VesselClassBreakdown(Search):
_INCLUDE_REFERENCE_DATA = True
def __init__(self):
Search.__init__(self, VESSEL_CLASS_BREAKDOWN_RESOURCE)
def search(
self,
breakdown_unit_average_basis: str = None,
filter_activity: str = "any_activity",
breakdown_unit: str = "b",
disable_geographic_exclusion_rules: bool = None,
breakdown_size: int = None,
filter_time_min: datetime = datetime(2019, 10, 1, 0),
filter_time_max: datetime = datetime(2019, 10, 1, 1),
filter_products: Union[ID, List[ID]] = None,
filter_charterers: Union[ID, List[ID]] = None,
filter_vessels: Union[ID, List[ID]] = None,
filter_vessel_classes: Union[str, List[str]] = None,
filter_owners: Union[ID, List[ID]] = None,
filter_effective_controllers: Union[ID, List[ID]] = None,
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,
filter_origins: Union[ID, List[ID]] = None,
filter_destinations: Union[ID, List[ID]] = None,
filter_storage_locations: Union[ID, List[ID]] = None,
filter_waypoints: Union[ID, List[ID]] = None,
filter_ship_to_ship_locations: Union[ID, List[ID]] = None,
filter_vessel_age_min: int = None,
filter_vessel_age_max: int = None,
filter_vessel_scrubbers: str = "disabled",
filter_vessel_tags: Union[List[Tag], Tag] = None,
exclude_products: Union[ID, List[ID]] = None,
exclude_vessels: Union[ID, List[ID]] = None,
exclude_vessel_classes: Union[str, List[str]] = None,
exclude_owners: Union[ID, List[ID]] = None,
exclude_effective_controllers: Union[ID, List[ID]] = None,
exclude_charterers: Union[ID, List[ID]] = None,
exclude_vessel_flags: Union[ID, List[ID]] = None,
exclude_destinations: Union[ID, List[ID]] = None,
exclude_origins: Union[ID, List[ID]] = None,
exclude_waypoints: Union[ID, List[ID]] = None,
exclude_storage_locations: Union[ID, List[ID]] = None,
exclude_ship_to_ship_locations: Union[ID, List[ID]] = None,
exclude_vessel_ice_class: Union[ID, List[ID]] = None,
exclude_vessel_propulsion: Union[ID, List[ID]] = None,
exclude_vessel_tags: Union[List[Tag], Tag] = None,
intra_movements: str = None,
) -> ReferenceBreakdownResult:
"""
Vessel class locations breakdown aggregation
# Arguments
breakdown_unit_average_basis: Per day metrics only - movement activity on which to base the average metric. Can be one of state properties of a cargo movement: `identified_for_loading_state`, `loading_state`, `transiting_state`, `storing_state`, `ship_to_ship`, `unloading_state`, `unloaded_state`, `oil_on_water_state`, `unknown_state`, or one of time properties of a cargo movement: `identified_for_loading_at`, `loading_start`, `loading_end`, `storing_start`, `storing_end`, `ship_to_ship_start`, `ship_to_ship_end`, `unloading_start`, `unloading_end`.
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. Default is 5.
disable_geographic_exclusion_rules: A boolean which specifies whether certain movements should be excluded, based on a combination of their origin and destination.
intra_movements: This enum controls a popular industry term intra-movements and determines the filter behaviour for cargo leaving then entering the same geographic area.
One of `all`, `exclude_intra_country` or `exclude_intra_geography`
filter_activity: Cargo movement activity on which to base the time filter. The endpoint only includes cargo
movements matching that match this filter in the aggregations. Must be one of ['loading_state',
'loading_start', 'loading_end', 'identified_for_loading_state', 'unloading_state', 'unloading_start',
'unloading_end', 'storing_state', 'storing_start', 'storing_end', 'transiting_state'].
filter_time_min: The UTC start date of the time filter.
filter_time_max: The UTC end date of the time filter.
filter_effective_controllers: An effective controller ID, or list of effective controller IDs to filter on.
filter_vessel_flags: A vessel flag ID, or list of vessel flag IDs to filter on.
filter_vessel_ice_class: An ice class ID, or list of ice class IDs to filter on.
filter_vessel_propulsion: An propulsion means ID, or list of propulsion means IDs to filter on.
filter_charterers: An commercial entity ID, or list of commercial entity IDs to filter on.
filter_origins: A geography ID, or list of geography IDs to filter on.
filter_destinations: A geography ID, or list of geography IDs to filter on.
filter_storage_locations: A geography ID, or list of geography IDs to filter on.
filter_waypoints: A geography ID, or list of geography IDs to filter on.
filter_ship_to_ship_locations: A geography ID, or list of geography 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_age_min: A number between 1 and 100 (representing years).
filter_vessel_age_max: A number between 1 and 100 (representing years).
filter_vessel_scrubbers: Either inactive 'disabled', or included 'inc' or excluded 'exc'.
filter_vessel_tags: A time bound vessel tag, or list of time bound vessel tags to filter on.
exclude_products: A product ID, or list of product IDs to exclude.
exclude_vessel_flags: A vessel flag ID, or list of vessel flag IDs to exclude.
exclude_vessel_ice_class: An ice class ID, or list of ice class IDs to exclude.
exclude_vessel_propulsion: An propulsion means ID, or list of propulsion means 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_effective_controllers: An effective controller ID, or list of effective controller IDs to exclude.
exclude_vessel_location: A location ID, or list of location IDs to exclude.
exclude_destinations: A location ID, or list of location IDs to exclude.
exclude_origins: A location ID, or list of location IDs to exclude.
exclude_storage_locations: A location ID, or list of location IDs to exclude.
exclude_waypoints: A location ID, or list of location IDs to exclude.
exclude_ship_to_ship_locations: A location ID, or list of location IDs to exclude.
exclude_vessel_tags: A time bound vessel tag, or list of time bound vessel tags to exclude.
# Returns
`ReferenceBreakdownResult`
# Example
_Breakdown by vessel class of cargoes in tonnes._
```python
>>> from vortexasdk import VesselClassBreakdown
>>> start = datetime(2019, 11, 10)
>>> end = datetime(2019, 11, 15)
>>> df = VesselClassBreakdown().search(
... filter_activity="loading_end",
... breakdown_unit="t",
... breakdown_size=5,
... filter_time_min=start,
... filter_time_max=end
... ).to_df()
```
Gives the following:
| | key | value | count |
|---:|:--------------------|---------:|----------:|
| 0 | vlcc_plus | 94855526 | 24 |
| 1 | aframax | 776599 | 17 |
| 2 | handymax | 381359 | 24 |
| 3 | handysize | 238723 | 21 |
| 4 | panamax | 118285 | 18 |
| 5 | tiny_tanker | 118285 | 18 |
| 6 | general_purpose | 118285 | 18 |
| 5 | sgc | 118285 | 18 |
"""
if disable_geographic_exclusion_rules is not None:
logger.warning(
f"\nYou are using the disable_geographic_exclusion_rules parameter. It will be deprecated in March 2024 in favour of the `intra_movements` filter.\nPlease refer to https://docs.vortexa.com/reference/intro-cargo-filters for more information.\n"
)
exclude_params: Dict[str, Any] = {
"filter_destinations": convert_to_list(exclude_destinations),
"filter_products": convert_to_list(exclude_products),
"filter_vessels": convert_to_list(exclude_vessels),
"filter_charterers": convert_to_list(exclude_charterers),
"filter_vessel_classes": convert_to_list(exclude_vessel_classes),
"filter_owners": convert_to_list(exclude_owners),
"filter_effective_controllers": convert_to_list(
exclude_effective_controllers
),
"filter_origins": convert_to_list(exclude_origins),
"filter_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
),
"filter_storage_locations": convert_to_list(
exclude_storage_locations
),
"filter_waypoints": convert_to_list(exclude_waypoints),
"filter_ship_to_ship": convert_to_list(
exclude_ship_to_ship_locations
),
}
api_params: Dict[str, Any] = {
"breakdown_unit_average_basis": breakdown_unit_average_basis,
"breakdown_unit": breakdown_unit,
"breakdown_size": breakdown_size,
"disable_geographic_exclusion_rules": disable_geographic_exclusion_rules,
"intra_movements": intra_movements,
"filter_time_min": to_ISODate(filter_time_min),
"filter_time_max": to_ISODate(filter_time_max),
"filter_activity": filter_activity,
"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_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
),
"filter_owners": convert_to_list(filter_owners),
"filter_effective_controllers": convert_to_list(
filter_effective_controllers
),
"filter_destinations": convert_to_list(filter_destinations),
"filter_origins": convert_to_list(filter_origins),
"filter_waypoints": convert_to_list(filter_waypoints),
"filter_charterers": convert_to_list(filter_charterers),
"filter_storage_locations": convert_to_list(
filter_storage_locations
),
"filter_ship_to_ship_locations": convert_to_list(
filter_ship_to_ship_locations
),
"filter_vessel_age_min": filter_vessel_age_min,
"filter_vessel_age_max": filter_vessel_age_max,
"filter_vessel_scrubbers": filter_vessel_scrubbers,
"vessel_tags": convert_to_list(filter_vessel_tags),
"vessel_tags_excluded": convert_to_list(exclude_vessel_tags),
"exclude": exclude_params,
"include_reference": self._INCLUDE_REFERENCE_DATA,
}
response = super().search_with_client(
response_type="breakdown", **api_params
)
return ReferenceBreakdownResult(
records=response["data"], reference=response["reference"]
)