Package Documentation¶
Vessel Emissions API Package.
Classes:
Name | Description |
---|---|
VesselEmissionsAPI |
Represents Signal's Vessel Emissions API. |
EmissionsEstimation |
Represents Emissions Estimation for a single Voyage. |
Metrics |
Represents Emissions Metrics for a Vessel. |
VesselClassEmissions |
Represents Emissions Estimation |
VesselClassMetrics |
Represents Emissions Metrics |
EmissionsEstimation
dataclass
¶
Contains info about the emissions estimation.
Attributes:
Name | Type | Description |
---|---|---|
id |
str
|
Voyage ID |
imo |
int
|
Vessel IMO |
vessel_name |
str
|
Vessel Name |
voyage_number |
int
|
Voyage Number |
vessel_type_id |
int
|
Vessel type id |
vessel_type |
Optional[str]
|
Vessel type |
vessel_class_id |
int
|
Vessel class id |
vessel_class |
Optional[str]
|
Vessel class |
start_date |
str
|
Start date of the Voyage |
end_date |
str
|
End date of the Voyage |
quantity |
Optional[float]
|
Cargo quantity of the voyage |
deadweight |
int
|
Vessel's deadweight |
transport_work_in_million_tonne_miles |
Optional[float]
|
Transport |
transport_work_in_million_dwt_miles |
Optional[float]
|
Transport work |
contains_eu_emissions |
Optional[bool]
|
Declares whether |
emissions |
EmissionsBreakdown
|
Emissions breakdown for the voyage |
consumptions |
Optional[ConsumptionsBreakdown]
|
Consumptions breakdown for the voyage |
seagoing_speed_statistics |
Optional[SeagoingSpeedStatisticsBreakdown]
|
Seagoing |
duration |
Optional[DurationBreakdown]
|
Duration breakdown for the voyage |
distances |
Optional[DistancesBreakdown]
|
Distance travelled breakdown for the voyage |
efficiency_metrics |
Optional[Metrics]
|
Emissions Efficiency metrics for the voyage |
european_union_regulated |
Optional[EmissionsEssentialStatistics]
|
European Union Related Emissions |
Source code in signal_ocean/vessel_emissions/models.py
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 |
|
__repr__()
¶
Override of the default repr function.
Returns:
Type | Description |
---|---|
str
|
Object string representation omitting None attributes |
Source code in signal_ocean/vessel_emissions/models.py
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 |
|
to_dict()
¶
Cast EmissionsEstimation object to dict.
Returns:
Type | Description |
---|---|
Dict[Any, Any]
|
Dict representation of EmissionsEstimation model |
Source code in signal_ocean/vessel_emissions/models.py
370 371 372 373 374 375 376 377 378 379 380 381 382 |
|
Metrics
dataclass
¶
Vessel Metrics estimation.
Attributes:
Name | Type | Description |
---|---|---|
voyage_cii |
Optional[float]
|
Carbon Intensity Indicator |
voyage_cii_unit |
Optional[str]
|
The unit of the voyage |
voyage_cii_rating |
Optional[str]
|
The rating of the vessel |
voyage_cii_target |
Optional[float]
|
The alignment target for the |
voyage_cii_target_year |
Optional[int]
|
The year that has taken |
capacity_eeoi |
Optional[float]
|
The EEOI efficiency metric when |
capacity_eeoi_unit |
Optional[str]
|
The unit of the Capacity |
capacity_eeoi_sea_cargo_charter_year_target |
Optional[float]
|
|
capacity_eeoi_sea_cargo_charter_class |
Optional[str]
|
|
capacity_eeoi_sea_cargo_charter_alignment_in_percentage |
Optional[float]
|
|
eeoi |
Optional[float]
|
The EEOI efficiency metrics calculated for the voyage |
eeoi_unit |
Optional[str]
|
The unit of the EEOI efficiency metrics |
eeoi_sea_cargo_charter_year_target |
Optional[float]
|
The alignment |
eeoi_sea_cargo_charter_class |
Optional[str]
|
The Sea Cargo Charter |
eeoi_sea_cargo_charter_alignment_in_percentage |
Optional[float]
|
|
kg_co2_per_tonne_cargo |
Optional[float]
|
Kg of CO2 per tonne of cargo carried |
kg_co2_per_tonne_dwt |
Optional[float]
|
Kg of CO2 per tonne of the vessel's deadweight |
Source code in signal_ocean/vessel_emissions/models.py
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 |
|
VesselClassEmissions
dataclass
¶
Contains Vessel Class Emissions.
Attributes:
Name | Type | Description |
---|---|---|
next_page_token |
str
|
String. The key to retrieve the next page |
data |
List[EmissionsEstimation]
|
List of Vessel Emissions for available vessels of this class |
Source code in signal_ocean/vessel_emissions/models.py
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 |
|
to_dict()
¶
Cast VesselClassEmissions object to dict.
Returns:
Type | Description |
---|---|
Dict[Any, Any]
|
Dict representation of VesselClassEmissions object |
Source code in signal_ocean/vessel_emissions/models.py
530 531 532 533 534 535 536 537 538 539 540 541 542 543 |
|
VesselClassMetrics
dataclass
¶
Contains Vessel Class Metrics.
Attributes:
Name | Type | Description |
---|---|---|
next_page_token |
str
|
String. The key that should be used |
data |
List[VesselMetrics]
|
List of Vessel Metrics for available vessels of this class |
Source code in signal_ocean/vessel_emissions/models.py
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 |
|
to_dict()
¶
Cast VesselClassMetrics object to dict.
Returns:
Type | Description |
---|---|
Dict[Any, Any]
|
Dict representation of VesselClassMetrics object |
Source code in signal_ocean/vessel_emissions/models.py
559 560 561 562 563 564 565 566 567 568 569 570 571 572 |
|
VesselEmissionsAPI
¶
Represents Signal's Vessel Emissions API.
Source code in signal_ocean/vessel_emissions/vessel_emissions_api.py
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 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
|
__init__(connection=None)
¶
Initializes VesselEmissionsAPI.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
connection |
Optional[Connection]
|
API connection configuration. If not provided, the default connection method is used. |
None
|
Source code in signal_ocean/vessel_emissions/vessel_emissions_api.py
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 |
|
construct_url_parameters(quantity=None, token=None, include_consumptions=False, include_efficiency_metrics=False, include_distances=False, include_durations=False, include_speed_statistics=False, include_eu_emissions=False, sulphur_content_hfo=None, sulphur_content_lfo=None, sulphur_content_mgo=None, sulphur_content_lng=None)
¶
Construct the request parameters based on the user's input.
Args: quantity: Cargo quantity of the voyage token: Next page token include_consumptions: Include consumption data in response include_efficiency_metrics: Include efficiency metrics in response include_distances: Include distances data in the response include_durations: Include duration data in the response include_speed_statistics: Include speed statistics data in response include_eu_emissions: Include European Union related emissions in response sulphur_content_hfo: Sulphur Content of HFO fuel type sulphur_content_lfo: Sulphur Content of LFO fuel type sulphur_content_mgo: Sulphur Content of MGO fuel type sulphur_content_lng: Sulphur Content of LNG fuel type
Returns:
Type | Description |
---|---|
Dict[Any, str]
|
The parameters dictionary of Request URL |
Source code in signal_ocean/vessel_emissions/vessel_emissions_api.py
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 |
|
get_emissions_by_imo(imo, include_consumptions=False, include_efficiency_metrics=False, include_distances=False, include_durations=False, include_speed_statistics=False, include_eu_emissions=False, sulphur_content_hfo=None, sulphur_content_lfo=None, sulphur_content_mgo=None, sulphur_content_lng=None)
¶
Retrieves a list of vessel emissions by its IMO.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
imo |
int
|
IMO of the vessel to retrieve emissions. |
required |
include_consumptions |
bool
|
Include consumption data in the response. |
False
|
include_efficiency_metrics |
bool
|
Include efficiency metrics data in the response. |
False
|
include_distances |
bool
|
Include distances data in the response. |
False
|
include_durations |
bool
|
Include duration data in the response. |
False
|
include_speed_statistics |
bool
|
Include speed statistics data in the response. |
False
|
include_eu_emissions |
bool
|
Include European Union related emissions data in the response. |
False
|
sulphur_content_hfo |
Union[float, None]
|
Sulphur Content of HFO fuel type. |
None
|
sulphur_content_lfo |
Union[float, None]
|
Sulphur Content of LFO fuel type. |
None
|
sulphur_content_mgo |
Union[float, None]
|
Sulphur Content of MGO fuel type. |
None
|
sulphur_content_lng |
Union[float, None]
|
Sulphur Content of LNG fuel type. |
None
|
Returns:
Type | Description |
---|---|
List[EmissionsEstimation]
|
A list of vessel emissions or None if no vessel with the specified IMO has been found. |
Source code in signal_ocean/vessel_emissions/vessel_emissions_api.py
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 |
|
get_emissions_by_imo_and_voyage_number(imo, voyage_number, quantity=None, include_consumptions=False, include_efficiency_metrics=False, include_distances=False, include_durations=False, include_speed_statistics=False, include_eu_emissions=False, sulphur_content_hfo=None, sulphur_content_lfo=None, sulphur_content_mgo=None, sulphur_content_lng=None)
¶
Retrieves voyage emissions for a vessel by its IMO and Voyage Number.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
imo |
int
|
Vessel IMO to retrieve. |
required |
voyage_number |
int
|
Voyage Number to retrieve. |
required |
quantity |
Union[int, None]
|
User defined transported quantity for voyage. |
None
|
include_consumptions |
bool
|
Include consumption data in the response. |
False
|
include_efficiency_metrics |
bool
|
Include efficiency metrics in response. |
False
|
include_distances |
bool
|
Include distances data in the response. |
False
|
include_durations |
bool
|
Include duration data in the response. |
False
|
include_speed_statistics |
bool
|
Include speed statistics in response. |
False
|
include_eu_emissions |
bool
|
Include European Union related |
False
|
sulphur_content_hfo |
Union[float, None]
|
Sulphur Content of HFO fuel type. |
None
|
sulphur_content_lfo |
Union[float, None]
|
Sulphur Content of LFO fuel type. |
None
|
sulphur_content_mgo |
Union[float, None]
|
Sulphur Content of MGO fuel type. |
None
|
sulphur_content_lng |
Union[float, None]
|
Sulphur Content of LNG fuel type. |
None
|
Returns:
Type | Description |
---|---|
Optional[EmissionsEstimation]
|
EmissionsEstimation if no vessel with |
Optional[EmissionsEstimation]
|
the specified IMO or Voyage Number has been found. |
Source code in signal_ocean/vessel_emissions/vessel_emissions_api.py
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 |
|
get_emissions_by_vessel_class_id(vessel_class_id, token=None, include_consumptions=False, include_efficiency_metrics=False, include_distances=False, include_durations=False, include_speed_statistics=False, include_eu_emissions=False)
¶
Get emissions estimations for a vessel class (supports incremental updates).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
vessel_class_id |
int
|
The vessel class to retrieve |
required |
token |
Union[str, None]
|
Next page token |
None
|
include_consumptions |
bool
|
Include consumption data in the response. |
False
|
include_efficiency_metrics |
bool
|
Include efficiency metrics data in the response. |
False
|
include_distances |
bool
|
Include distances data in the response. |
False
|
include_durations |
bool
|
Include duration data in the response. |
False
|
include_speed_statistics |
bool
|
Include speed statistics data in the response. |
False
|
include_eu_emissions |
bool
|
Include European Union related emissions data in the response. |
False
|
Returns:
Type | Description |
---|---|
Optional[VesselClassEmissions]
|
List of emissions estimation for all available voyages of a vessel class. |
Source code in signal_ocean/vessel_emissions/vessel_emissions_api.py
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
|
get_metrics_by_imo(imo, year=None)
¶
Get vessel metrics.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
imo |
int
|
Vessel IMO to retrieve |
required |
year |
Union[int, None]
|
The year for the annual metrics |
None
|
Returns:
Type | Description |
---|---|
List[VesselMetrics]
|
VesselMetrics for the requested IMO |
Source code in signal_ocean/vessel_emissions/vessel_emissions_api.py
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
|
get_metrics_by_vessel_class_id(vessel_class_id, year=None, token=None)
¶
Get vessel class metrics.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
vessel_class_id |
int
|
The vessel class to retrieve |
required |
year |
Union[int, None]
|
The year for the annual metrics |
None
|
token |
Union[str, None]
|
Next page token |
None
|
Returns:
Type | Description |
---|---|
Optional[VesselClassMetrics]
|
VesselClassMetrics for the requested Class |
Source code in signal_ocean/vessel_emissions/vessel_emissions_api.py
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
|