Skip to content

feat: update python #567

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Jack-Burge55 wants to merge 1 commit into from
Closed

feat: update python #567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/examples/academy_use_cases/Freight & Voyages/Case Study of Voyages data.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
},
{
"cell_type": "code",
"execution_count": 3,
"execution_count": null,
"id": "f2610ef4",
"metadata": {
"ExecuteTime": {
Expand Down Expand Up @@ -284,7 +284,7 @@
" exclude_vessel_classes=vessel_class_excl,\n",
" filter_destination=heading_to,\n",
" exclude_destination=heading_to_excl,\n",
" filter_days_to_arrival=[{\"min\": laycan_min, \"max\": laycan_max}], # specify laycan window\n",
" filter_days_to_arrival={\"min\": laycan_min, \"max\": laycan_max}, # specify laycan window\n",
" filter_vessel_scrubbers=\"disabled\",\n",
" filter_vessel_status=status,\n",
" use_reference_port=True\n",
Expand Down Expand Up @@ -1440,7 +1440,7 @@
"metadata": {},
"source": [
"# Example 1: Fleet distribution per location\n",
"Track changes in tanker numbers in a custom set of Vortexa locations. In this example we monitor the supply of MR2 tankers in each basin (Atlantic and Pacific). This can indicate where supply side pressure might come into play for freight rates in various regions, as well as highlight changes in tanker migration patterns.",
"Track changes in tanker numbers in a custom set of Vortexa locations. In this example we monitor the supply of MR2 tankers in each basin (Atlantic and Pacific). This can indicate where supply side pressure might come into play for freight rates in various regions, as well as highlight changes in tanker migration patterns.\n",
"\n",
"\n",
"**Note:** *The `risk_rating` and `risk_rating_excl` parameters (which map to `vessel_risk_level` and `vessel_risk_level_excluded` in the API) may not be available for all accounts. If not available, the filter will be ignored, results will not be filtered by risk level, and vessel_risk_level will not appear in response data.*"
Expand Down Expand Up @@ -3206,7 +3206,7 @@
" </tr>\n",
" </tbody>\n",
"</table>\n",
"<p>164 rows \u00d7 3 columns</p>\n",
"<p>164 rows × 3 columns</p>\n",
"</div>"
],
"text/plain": [
Expand Down Expand Up @@ -3407,4 +3407,4 @@
},
"nbformat": 4,
"nbformat_minor": 5
}
}
12 changes: 6 additions & 6 deletions docs/examples/academy_use_cases/Freight & Voyages/Fleet distribution per location.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
},
{
"cell_type": "code",
"execution_count": 6,
"execution_count": null,
"id": "f2610ef4",
"metadata": {
"ExecuteTime": {
Expand Down Expand Up @@ -293,7 +293,7 @@
" exclude_vessel_classes=vessel_class_excl,\n",
" filter_destination=heading_to,\n",
" exclude_destination=heading_to_excl,\n",
" filter_days_to_arrival=[{\"min\": laycan_min, \"max\": laycan_max}], # specify laycan window\n",
" filter_days_to_arrival={\"min\": laycan_min, \"max\": laycan_max}, # specify laycan window\n",
" filter_vessel_scrubbers=\"disabled\",\n",
" filter_vessel_status=status,\n",
" use_reference_port=True\n",
Expand Down Expand Up @@ -1449,7 +1449,7 @@
"metadata": {},
"source": [
"# Example 1: Fleet distribution per location\n",
"Track changes in tanker numbers in a custom set of Vortexa locations. In this example we monitor the supply of MR2 tankers in each basin (Atlantic and Pacific). This can indicate where supply side pressure might come into play for freight rates in various regions, as well as highlight changes in tanker migration patterns.",
"Track changes in tanker numbers in a custom set of Vortexa locations. In this example we monitor the supply of MR2 tankers in each basin (Atlantic and Pacific). This can indicate where supply side pressure might come into play for freight rates in various regions, as well as highlight changes in tanker migration patterns.\n",
"\n",
"\n",
"**Note:** *The `risk_rating` and `risk_rating_excl` parameters (which map to `vessel_risk_level` and `vessel_risk_level_excluded` in the API) may not be available for all accounts. If not available, the filter will be ignored, results will not be filtered by risk level, and vessel_risk_level will not appear in response data.*"
Expand All @@ -1470,7 +1470,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
"2024-09-17 15:52:52,899 vortexasdk.client \u2014 WARNING \u2014 You are using vortexasdk version 0.73.0, however version 0.73.1 is available.\n",
"2024-09-17 15:52:52,899 vortexasdk.client — WARNING — You are using vortexasdk version 0.73.0, however version 0.73.1 is available.\n",
"You should consider upgrading via the 'pip install vortexasdk --upgrade' command.\n",
"Downloading vessel_count for period: 2018-01-01 00:00:00 to 2021-12-31 23:59:59\n",
"Downloading vessel_count for period: 2022-01-01 00:00:00 to 2024-09-17 15:53:38.241636\n",
Expand Down Expand Up @@ -15343,7 +15343,7 @@
" </tr>\n",
" </tbody>\n",
"</table>\n",
"<p>196 rows \u00d7 3 columns</p>\n",
"<p>196 rows × 3 columns</p>\n",
"</div>"
],
"text/plain": [
Expand Down Expand Up @@ -42607,4 +42607,4 @@
},
"nbformat": 4,
"nbformat_minor": 5
}
}
2 changes: 1 addition & 1 deletion ...ples/academy_use_cases/Freight & Voyages/Vessel availability freight rate causality.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@
" exclude_vessel_classes=vessel_class_excl,\n",
" filter_destination=heading_to,\n",
" exclude_destination=heading_to_excl,\n",
" filter_days_to_arrival=[{\"min\": laycan_min, \"max\": laycan_max}], # specify laycan window\n",
" filter_days_to_arrival={\"min\": laycan_min, \"max\": laycan_max}, # specify laycan window\n",
" filter_vessel_scrubbers=\"disabled\",\n",
" filter_vessel_status=status,\n",
" use_reference_port=True\n",
Expand Down
2 changes: 1 addition & 1 deletion tests/endpoints/test_availability_breakdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def test_search(self):
df = (
VesselAvailabilityBreakdown()
.search(
filter_days_to_arrival=[{"min": 0, "max": 5}],
filter_days_to_arrival={"min": 0, "max": 5},
filter_port=rotterdam,
)
.to_df()
Expand Down
4 changes: 2 additions & 2 deletions vortexasdk/endpoints/vessel_availability_breakdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def search(
filter_region: Optional[str] = None,
filter_port: Optional[str] = None,
use_reference_port: bool = False,
filter_days_to_arrival: Optional[List[Dict[str, int]]] = None,
filter_days_to_arrival: Optional[Dict[str, int]] = None,
filter_vessel_dwt_min: Optional[int] = None,
filter_vessel_dwt_max: Optional[int] = None,
filter_vessel_age_min: Optional[int] = None,
Expand Down Expand Up @@ -212,7 +212,7 @@ def search(
"filter_region": filter_region,
"filter_port": filter_port,
"use_reference_port": use_reference_port,
"filter_days_to_arrival": convert_to_list(filter_days_to_arrival),
"filter_days_to_arrival": filter_days_to_arrival,
"filter_vessel_dwt_min": filter_vessel_dwt_min,
Comment on lines 212 to 216
"filter_vessel_dwt_max": filter_vessel_dwt_max,
"filter_vessel_age_min": filter_vessel_age_min,
Expand Down
4 changes: 2 additions & 2 deletions vortexasdk/endpoints/vessel_availability_search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def search(
filter_owners: Optional[Union[ID, List[ID]]] = None,
filter_effective_controllers: Optional[Union[ID, List[ID]]] = None,
filter_destination: Optional[Union[ID, List[ID]]] = None,
filter_days_to_arrival: Optional[List[Dict[str, int]]] = None,
filter_days_to_arrival: Optional[Dict[str, int]] = None,
filter_vessel_dwt_min: Optional[int] = None,
filter_vessel_dwt_max: Optional[int] = None,
filter_vessel_age_min: Optional[int] = None,
Expand Down Expand Up @@ -219,7 +219,7 @@ def search(
"filter_region": filter_region,
"filter_port": filter_port,
"use_reference_port": use_reference_port,
"filter_days_to_arrival": convert_to_list(filter_days_to_arrival),
"filter_days_to_arrival": filter_days_to_arrival,
"filter_vessel_dwt_min": filter_vessel_dwt_min,
Comment on lines 219 to 223
"filter_vessel_dwt_max": filter_vessel_dwt_max,
"filter_vessel_age_min": filter_vessel_age_min,
Expand Down
4 changes: 2 additions & 2 deletions vortexasdk/endpoints/vessel_availability_timeseries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def search(
filter_region: Optional[str] = None,
filter_port: Optional[str] = None,
use_reference_port: bool = False,
filter_days_to_arrival: Optional[List[Dict[str, int]]] = None,
filter_days_to_arrival: Optional[Dict[str, int]] = None,
filter_vessel_dwt_min: Optional[int] = None,
filter_vessel_dwt_max: Optional[int] = None,
filter_vessel_age_min: Optional[int] = None,
Expand Down Expand Up @@ -226,7 +226,7 @@ def search(
"filter_region": filter_region,
"filter_port": filter_port,
"use_reference_port": use_reference_port,
"filter_days_to_arrival": convert_to_list(filter_days_to_arrival),
"filter_days_to_arrival": filter_days_to_arrival,
"filter_vessel_dwt_min": filter_vessel_dwt_min,
Comment on lines 226 to 230
"filter_vessel_dwt_max": filter_vessel_dwt_max,
"filter_vessel_age_min": filter_vessel_age_min,
Expand Down
Loading