vortexasdk 0.13.0

Vortexa SDK

VortexaSDK

Welcome to Vortexa's Python Software Development Kit (SDK)! We built the SDK to provide fast, interactive, programmatic exploration of our data. The tool lets Data Scientists, Analysts and Developers efficiently explore the world’s waterborne oil movements, and to build custom models & reports with minimum setup cost.

The SDK sits as a thin python wrapper around Vortexa's API, giving you immediate access to pandas DataFrames.

Quick Start

Installation

The SDK requires Python version 3.7 or above.

$ pip install vortexasdk

Check the Setup FAQ page for more details

Authentication

Set your VORTEXA_API_KEY environment variable, that's all. Check the Setup FAQ page for more details

Example

In an interactive python console, run:

>>> from datetime import datetime
>>> from vortexasdk import CargoMovements
>>> df = CargoMovements()\
        .search(filter_activity='loading_state',
            filter_time_min=datetime(2017, 8, 1, 23),
            filter_time_max=datetime(2017, 8, 1, 23))\
        .to_df()

returns

	quantity	vessels.0.name	product.group.label	product.grade.label	events.cargo_port_load_event.0.end_timestamp	events.cargo_port_unload_event.0.start_timestamp
0	1998	ALSIA SWAN	Clean products	Lube Oils	2017-08-01T06:10:45+0000	2017-08-27T14:38:15+0000
1	16559	IVER AMBITION	Dirty products	nan	2017-08-02T17:20:51+0000	2017-09-07T07:52:20+0000
2	522288	BLUE SUN	Crude	Gharib	2017-08-02T04:22:09+0000	2017-08-13T10:32:09+0000
3	46260	XINWANYU16	Clean products	Chemicals	2017-08-01T01:07:40+0000	2017-08-10T06:21:43+0000

Alternatively, you can copy the contents of example_load_cargo_movements.py into a file named example.py and run python example.py from your terminal or powershell console.

Next Steps

Learn how to call Endpoints

Glossary

The Glossary can be found at Vortexa API Documentation. The Glossary outlines key terms, functions and assumptions aimed at helping to extract powerful findings from our data.

Documentation

Read the documentation at VortexaSDK Docs

Contributing

We welcome contributions! Please read our Contributing Guide for ways to offer feedback and contributions.

Thanks goes to these wonderful contributors (emoji key):

Kit Burgess 🎨 💻	tinovs 💻 👀	David Andrew Starkey 💻 📖 💡	syed 👀	Jakub Korzeniowski 🤔	Edward Wright 📓	Patrick Roddy 📓
Romain 📓 🤔	Natday 💼 🤔 📓	ArthurD1 📓	Chloe Connor 📓	Achilleas Sfakianakis 📓

This project follows the all-contributors specification. Contributions of any kind welcome!