/
index.html
359 lines (308 loc) · 17.7 KB
/
index.html
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
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
357
358
359
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Setup - VortexaSDK</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700" />
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Setup";
var mkdocs_page_input_path = "faq_setup.md";
var mkdocs_page_url = null;
</script>
<script src="../js/jquery-2.1.1.min.js" defer></script>
<script src="../js/modernizr-2.8.3.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-153895438-1', 'vortechsa.github.io');
ga('send', 'pageview');
</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> VortexaSDK</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Endpoints</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/about-endpoints/">About Endpoints</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/attributes/">Attributes</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/canal_transit/">Canal Transit</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/canal_transit_timeseries/">Canal Transit Timeseries</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/cargo_movements/">Cargo Movements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/movement_status_breakdown/">Movement Status Breakdown</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/product_breakdown/">Product Breakdown</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/parent_product_breakdown/">Parent Product Breakdown</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/vessel_class_breakdown/">Vessel Class Breakdown</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/origin_breakdown/">Origin Breakdown</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/destination_breakdown/">Destination Breakdown</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/cargo_timeseries/">Cargo Time Series</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/corporations/">Corporations</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/eia_forecasts/">EIA Forecasts</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/geographies/">Geographies</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/products/">Products</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/vessels/">Vessels</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../endpoints/fixtures/">Fixtures</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="#">Vessel Availability</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/vessel_availability_search/">Search</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/vessel_availability_timeseries/">Time Series</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/vessel_availability_breakdown/">Breakdown</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#">Crude Onshore Inventories</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/onshore_inventories_search/">Search</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/onshore_inventories_timeseries/">Time Series</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#">Reference Data</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="../endpoints/asset_tanks/">Asset Tanks</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="../endpoints/storage_terminals/">Storage Terminals</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#">Freight Pricing</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/freight_pricing_search/">Search</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/freight_pricing_timeseries/">Time Series</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#">Voyages</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/voyages_search_enriched/">Search Enriched</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/voyages_timeseries/">Time Series</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/voyages_timeseries_v2/">Time Series V2</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/voyages_top_hits/">Top Hits</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/voyages_geography_breakdown/">Geography Breakdown</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/voyages_vessel_class_breakdown/">Vessel Class Breakdown</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/voyages_product_breakdown/">Product Breakdown</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/voyages_routes_breakdown/">Routes Breakdown</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/voyages_congestion_breakdown/">Congestion Breakdown</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#">Signals</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/vessel_summary/">Vessel Summary</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="../endpoints/vessel_positions/">Vessel Positions</a>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Entities</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../entities/canal_transit/">Canal Transit</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../entities/cargo_movement/">Cargo Movement</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../entities/corporation/">Corporation</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../entities/geography/">Geography</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../entities/product/">Product</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../entities/vessel/">Vessel</a>
</li>
<li class="toctree-l1"><a class="" href="../entities/vessel_movement.md">Vessel Movement</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../entities/voyages/">Voyages</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../entities/vessel_availability/">Vessel Availability</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../entities/timeseries_item/">Time Series Item</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../entities/breakdown_item/">Breakdown Item</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../entities/signals/">Signals</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../config/">Config</a>
</li>
</ul>
<p class="caption"><span class="caption-text">FAQ</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../faq/">General</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Setup</a>
<ul class="current">
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Examples</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../examples/0_sample_load_cargo_movements/">0 Simple Load Cargo Movements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../examples/1_china/">1 China VLCC Discharges</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../examples/jupyter_notebooks/">Jupyter Notebooks</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">VortexaSDK</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> »</li>
<li>FAQ »</li>
<li>Setup</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/vortechsa/python-sdk/edit/master/docs/faq_setup.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h4 id="how-to-install-python-on-windows-using-anaconda">How to install Python on Windows using Anaconda</h4>
<ul>
<li>Download the Python3.7 Graphical installer from the <a href="https://www.anaconda.com/distribution/">anaconda website</a></li>
<li>Follow the conda installation instructions</li>
</ul>
<h4 id="how-do-i-install-the-sdk-on-windows">How do I install the SDK on Windows?</h4>
<ul>
<li>First, open up an Anaconda Prompt. Hit the start button and type anaconda prompt.</li>
</ul>
<p><img alt="Anaconda prompt" src="../img/anaconda_prompt.png" /></p>
<ul>
<li>Use pip to install the sdk</li>
</ul>
<p>Run <code>pip install --user vortexasdk</code> in the anaconda command prompt</p>
<p><img alt="pip_install.png" src="../img/pip_install.png" /></p>
<p>You're done! The VortexaSDK has now been installed.</p>
<h4 id="how-do-i-install-the-sdk-on-mac-linux">How do I install the SDK on Mac / Linux?</h4>
<p>Type the following into a bash terminal</p>
<pre><code class="language-bash">$ pip install vortexasdk
</code></pre>
<h4 id="how-do-i-add-an-environment-variable-on-windows">How do I add an environment variable on Windows?</h4>
<ul>
<li>Hit the windows key, then type "environment" to open up a control panel settings page titled "Edit the system environment variables"</li>
</ul>
<p><img alt="edit_system_env_vars.png" src="../img/edit_system_env_vars.png" /></p>
<ul>
<li>In the System Properties window, click on the Advanced tab, then click the Environment Variables button near the bottom of that tab.</li>
<li>Add a new user variable</li>
</ul>
<p><img alt="add_env_var.png" src="../img/add_env_var.png" /></p>
<h4 id="where-is-my-api-key">Where is my API Key?</h4>
<p>Refer to <a href="https://docs.vortexa.com/reference/intro-authentication">Vortexa API Authentication</a>
for details, including instructions on where to find your API key.</p>
<h4 id="how-do-i-request-an-api-key">How do I request an API Key?</h4>
<p>You can <a href="https://www.vortexa.com/request-demo-sdk">request a demo here</a>.</p>
<p>More details are given in <a href="https://docs.vortexa.com/reference/intro-authentication">docs.vortexa.com</a>.</p>
<p>Alternatively, please get in touch at <a href="https://www.vortexa.com/">www.vortexa.com</a>.</p>
<h4 id="how-can-i-check-the-sdk-is-setup-correctly">How can I check the SDK is setup correctly?</h4>
<p>Run the following in a bash console on Mac/Linux, or command prompt on Windows:</p>
<pre><code class="language-bash">$ python -m vortexasdk.check_setup
</code></pre>
<p>A successful setup looks like this:</p>
<p><img alt="check_setup.png" src="../img/check_setup.png" /></p>
<p>On Windows, you'll need to paste the API key by right clicking the console menu, like so:</p>
<p>Hitting Ctrl+V won't paste the API key, this is due to a <a href="https://bugs.python.org/issue37426">known python windows bug</a>
<img alt="get_pass.png" src="../img/get_pass_windows.png" /></p>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../examples/0_sample_load_cargo_movements/" class="btn btn-neutral float-right" title="0 Simple Load Cargo Movements">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../faq/" class="btn btn-neutral" title="General"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/vortechsa/python-sdk/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../faq/" style="color: #fcfcfc">« Previous</a></span>
<span><a href="../examples/0_sample_load_cargo_movements/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>