/
cargo_movements.py
288 lines (224 loc) · 16.6 KB
/
cargo_movements.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
276
277
278
279
280
281
282
283
284
285
286
287
288
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Fcargo_movements.ipynb)
"""
from datetime import datetime
from typing import Any, Dict, List, Union
from vortexasdk.api import ID
from vortexasdk.api.shared_types import to_ISODate
from vortexasdk.endpoints.cargo_movements_result import CargoMovementsResult
from vortexasdk.endpoints.endpoints import (
CARGO_MOVEMENTS_RESOURCE,
CARGO_MOVEMENT_RESOURCE,
)
from vortexasdk.logger import get_logger
from vortexasdk.operations import Record, Search
from vortexasdk.utils import convert_to_list
logger = get_logger(__name__)
class CargoMovements(Record, Search):
"""
Cargo Movements Endpoint, use this to search through Vortexa's cargo movements.
A detailed explanation of Cargo/Vessel Movements can be found [here](https://docs.vortexa.com/reference/intro-movement-difference).
"""
_MAX_PAGE_RESULT_SIZE = 500
def __init__(self):
Record.__init__(self, CARGO_MOVEMENT_RESOURCE)
Search.__init__(self, CARGO_MOVEMENTS_RESOURCE)
def search(
self,
filter_activity: str = None,
filter_time_min: datetime = datetime.now(),
filter_time_max: datetime = datetime.now(),
cm_unit: str = "b",
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_effective_controllers: 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_storage_locations: Union[ID, List[ID]] = None,
filter_ship_to_ship_locations: Union[ID, List[ID]] = None,
filter_waypoints: Union[ID, List[ID]] = None,
filter_vessel_age_min: int = None,
filter_vessel_age_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_effective_controllers: 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,
disable_geographic_exclusion_rules: bool = None,
) -> CargoMovementsResult:
"""
Find CargoMovements matching the given search parameters.
# Arguments
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', 'oil_on_water_state'].
filter_time_min: The UTC start date of the time filter.
filter_time_max: The UTC end date of the time filter.
cm_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_effective_controllers: An effective controller ID, or list of effective controller 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_storage_locations: 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_waypoints: A geography ID, or list of geography IDs 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_flags: A vessel flag, or list of vessel flags 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.
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_filter_effective_controllers: An effective controller ID, or list of effective controller 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.
disable_geographic_exclusion_rules: This controls a popular industry term "intra-movements" and determines
the filter behaviour for cargo leaving then entering the same geographic area.
# Returns
`CargoMovementsResult`, containing all the cargo movements matching the given search terms.
# Example
* _Which cargoes were loaded from Rotterdam on the morning of 1st December 2018?_
```python
>>> from vortexasdk import CargoMovements, Geographies
>>> rotterdam = [g.id for g in Geographies().search("rotterdam").to_list() if "port" in g.layer]
>>> search_result = CargoMovements().search(
... filter_origins=rotterdam,
... filter_activity='loading_state',
... filter_time_min=datetime(2018, 12, 1),
... filter_time_max=datetime(2018, 12, 1, 12))
>>> df = search_result.to_df(columns=['product.grade.label', 'product.group.label', 'vessels.0.vessel_class'])
```
| | product.group.label | product.grade.label | vessels.0.vessel_class |
|---:|:----------------------|:--------------------------------|:-------------------------|
| 0 | Clean products | Pygas | general_purpose |
| 1 | Clean products | Chemicals | tiny_tanker |
| 2 | Clean products | Chemicals | tiny_tanker |
| 3 | Dirty products | Low Sulphur VGO (LSVGO) | general_purpose |
| 4 | Clean products | ULSD (Ultra Low Sulphur Diesel) | general_purpose |
| 5 | Clean products | Chemicals | tiny_tanker |
| 6 | Clean products | Finished Gasoline | handymax |
* _Which VLCC cargoes passed through the Suez canal en route to China?_
Note here we include vessels.0..., vessels.1..., vessels.2... columns.
This lets us view all vessels present in any STS operations.
```python
>>> from vortexasdk import CargoMovements, Geographies, Vessels
>>> suez = [g.id for g in Geographies().search("suez").to_list()]
>>> china = [g.id for g in Geographies().search("china").to_list() if "country" in g.layer]
>>> vlccs = [v.id for v in Vessels().search(vessel_classes="vlcc_plus").to_list()]
>>> cargo_movement_search_result = CargoMovements().search(
... filter_destinations=china,
... filter_activity="loading_state",
... filter_waypoints=suez,
... filter_vessels=vlccs,
... filter_time_min=datetime(2018, 12, 1),
... filter_time_max=datetime(2018, 12, 1))
>>> cols = ['vessels.0.name', 'vessels.0.vessel_class', 'vessels.1.name', 'vessels.1.vessel_class', 'vessels.2.name', 'vessels.2.vessel_class', 'product.group.label', 'quantity']
>>> cargo_movements_df = cargo_movement_search_result.to_df(columns=cols)
```
| | vessels.0.name | vessels.0.vessel_class | vessels.1.name | vessels.1.vessel_class | vessels.2.name | vessels.2.vessel_class | product.group.label | quantity |
|---:|:-----------------|:-------------------------|:-----------------|:-------------------------|:-----------------|:-------------------------|:----------------------|-----------:|
| 0 | MINERVA MARINA | suezmax | COSGLORY LAKE | vlcc_plus | nan | nan | Crude | 700614 |
| 1 | BUKHA | vlcc_plus | nan | nan | nan | nan | Crude | 1896374 |
| 2 | ATHENIAN FREEDOM | vlcc_plus | nan | nan | nan | nan | Crude | 183537 |
| 3 | ATINA | suezmax | DONAT | suezmax | DS VISION | vlcc_plus | Crude | 896773 |
| 4 | MINERVA MARINA | suezmax | COSGLORY LAKE | vlcc_plus | nan | nan | Crude | 405724 |
| 5 | MASAL | suezmax | EKTA | vlcc_plus | nan | nan | Crude | 997896 |
| 6 | ATHENIAN FREEDOM | vlcc_plus | nan | nan | nan | nan | Crude | 120812 |
[Cargo Movements Endpoint Further Documentation](https://docs.vortexa.com/reference/POST/cargo-movements/search)
"""
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_effective_controllers": convert_to_list(
exclude_effective_controllers
),
"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] = {
"filter_activity": filter_activity,
"filter_time_min": to_ISODate(filter_time_min),
"filter_time_max": to_ISODate(filter_time_max),
"cm_unit": cm_unit,
"filter_charterers": convert_to_list(filter_charterers),
"filter_owners": convert_to_list(filter_owners),
"filter_effective_controllers": convert_to_list(
filter_effective_controllers
),
"filter_products": convert_to_list(filter_products),
"filter_vessels": convert_to_list(filter_vessels),
"filter_vessel_classes": convert_to_list(filter_vessel_classes),
"filter_destinations": convert_to_list(filter_destinations),
"filter_origins": convert_to_list(filter_origins),
"filter_storage_locations": convert_to_list(
filter_storage_locations
),
"filter_ship_to_ship_locations": convert_to_list(
filter_ship_to_ship_locations
),
"filter_waypoints": convert_to_list(filter_waypoints),
"filter_vessel_age_min": filter_vessel_age_min,
"filter_vessel_age_max": filter_vessel_age_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
),
"exclude": exclude_params,
"disable_geographic_exclusion_rules": disable_geographic_exclusion_rules,
"size": self._MAX_PAGE_RESULT_SIZE,
}
response = super().search_with_client_with_search_after(**api_params)
return CargoMovementsResult(
records=response["data"], reference=response["reference"]
)
def record(self, id: ID, params: Dict = {}) -> Dict:
"""
Perform a cargo movement lookup.
# Arguments
id: Cargo movement ID to lookup (long_id or short_id)
params: Supported search params:
'unit': enter 'b' for barrels, 't' for tonnes and 'cbm' for cubic meters
# Returns
Cargo movement record matching the ID
# Further Documentation:
[VortexaAPI Cargo Movement](https://docs.vortexa.com/reference/GET/cargo-movements/%7Bid%7D)
"""
return super().record_with_params(id, params)