Quick Start: Stream data via the Quix portal

Aim

This guide will take you through the steps to import data from a CSV into the Quix platform. By the end you will have:

  • Explored the Quix portal and viewed sections representing the core platform concepts

  • Completed a run of sample code that sends data to a Topic

  • Visualized the data you’ve imported

Before you begin

  • You must have an account on the Quix portal that you can log into.

  • You should be familiar with the terms Topic, Stream, and Parameter from the Definitions section of the Getting Started chapter.

Overview

This walkthrough covers the following steps:

  1. Create a workspace

  2. Create a topic

  3. Deploy a sample project

  4. Run the sample project

  5. Visualize imported data

Create a Workspace

If you already have a workspace set up, feel free to use it, in which case you may bypass this step.

  1. From the portal home page, click CREATE NEW WORKSPACE.

  2. In the “New workspace” dialog, enter a name for your workspace — Quick start — and click CREATE.

INFO: You’ll see a card representing the new workspace. Its Status will move from Creating to Ready in a short period of time, at which point you may continue.

create a workspace

Create a Topic

  1. Click the Topics button An icon showing a right-to-left arrow on top of a left-to-right arrow for the Workspace you just created.

  2. Click the CREATE TOPIC button.

  3. In the “New topic” dialog, enter a name for your topic — cars — and click CREATE.

Your new topic will be displayed in the topic list. After a short period of time, “Status” will go from “Creating” to “Ready”, at which point you may continue.
Data sent to the new topic will not be persisted in the by default.
  1. To persist data, click the OFF toggle under the “Persistence” column. You will be asked to confirm this change. Click the PERSIST button to confirm. After a few seconds, the Topic will be set to persist.

topic persist

Deploy a Sample Project

Sample projects can be deployed to the Quix compute environment. The sample we’ll use contains a single Python script, main.py. This script imports sample data from a csv file, cardata.csv.

  1. Click the Library icon library icon in the left-hand menu.

You should see a default sample project headed “Write Topic Data”. You’ll also see the project’s files and the contents of the selected file in the file browser. You can explore the code with reference to the SDK docs but feel free to proceed at any time.
  1. Click SAVE AS PROJECT in the top-right of this page.

  2. You’ll see a “New project” dialog. Enter a name for this project — e.g. “cardata” and click CREATE.

  3. Your new project is now shown in the “Develop” section. Click the DEPLOY button.

  4. You’ll see the “New Deployment” dialog, from which you can configure various aspects of your deployment. For now, proceed by clicking DEPLOY.

Run the Sample Project

Once deployed, your sample project will run automatically.

  1. After a few seconds, you’ll be taken to the Deployment section. Your deployment will be in the “Building” status and will quickly move through “Starting” and “Running” to “Completed”.

deploy completed

Visualize Imported Data

  1. Click the Data icon data icon in the left-hand menu.

  2. You’ll see your “cardata” Stream displayed. Hover over it and click the “Visualize” icon visualize icon that appears alongside.

  3. On the Visualize page, you’ll select Parameters to display in a Waveform. Click the SELECT button alongside “Parameters:”.

  4. Select two parameters from the dialog: Speed and Gear. Then click CLOSE.

Your chosen Parameters will be shown in a Waveform. You can navigate the data using the buttons below.
\

Next steps

  • Learn about the features provided by the Quix SDK

  • Find out about the core concepts in streaming data-driven engineering