Getting Started

### Install PolySync #### Compatibility For development, most PolySync users stick with x86 processors running Ubuntu Linux 14.04, but it’s made to be fully embeddable. We support other systems─everything from Raspberry Pi to NVIDIA DrivePX─view the full list of supported architectures . ### 1. Download To begin, you can use either our GUI installer or manually install with our tarball download . For the purposes of this introduction, we’ll be using the GUI installer, but if you’d like to take a crack at the manual method, we recommend you first arm yourself with our dependency list. ### 2. Install After downloading the PolySync installer, open a terminal and navigate to the directory where it has been downloaded. Then run the following command. ```bash $ bash polysync-release-2.0-x86_64.bin ``` It can take up to 15 minutes for all installation and configuration steps to complete. #### 2.1 Install on distributed systems If you are working with a distributed system, then you can follow the Distributed Host Set Up article to prepare your system for running PolySync applications with multiple hosts. ### 3. Activate When installation completes, the installer will ask for an activation ID. If you have already received a trial license, enter it (hyphens included). If not, please visit our [Request a Trial License](/articles/?p=1707) article to request one. Once you’ve received your ID, you can apply it post-installation with the following command: ```bash $ polysync-license-tool -a ACTIVATION-ID-GOES-HERE ``` ### 4. Upgrade To upgrade, just run a newer version of the installer. The installer will detect previous installations and settings and ask if you would like to backup the previous installation into the /opt directory. Before doing this, though, you should backup your current SDF and any applications you have developed that are located within the /usr/local/polysync/ directory. ### 5. Studio The **PolySync manager** manages the communication of messages between nodes on the bus . In this example, we’re going to use the manager to start the predefined nodes from the System Design File (SDF) using the following command: ```bash $ polysync-manager -n -w ``` The '-n' flag spawns all nodes that are defined and enabled in the SDF. The '-w' flag switches the system to "no hardware" mode, so that you can replay data. For more information on PolySync manager, run `$ polysync-manager -h`. PolySync Studio allows data being published to the PolySync bus to be visualized and debugged. It also provides a replay module that can play back sessions, which are simply collections of log files that have been recorded together. To open Studio, select PolySync Studio from the application directory, or in the command line type: ```bash $ polysync-studio ``` Once Studio has loaded, you’ll see the plugin loader on the right hand of the screen. In this example, we’ll add new instances of the system hierarchy and 3D view plugins to the workspace. These will allow you to view the runtime status of the nodes or (in this case) view data captured in the logfiles. ### 6. Check for errors Check the [system state](https://help.polysync.io/releases/2.0.8//articles/system-state/) module for any nodes that are in an error state by clicking the icon. ![Finding system state icon](https://help.polysync.io/releases/2.0.8//wp-content/uploads/2016/11/system-state-icon.png) If one or more nodes are in an error state, click the icon at the bottom-right of the application window to bring up the console. In this example, the system hierarchy plugin shows that the SDF has defined three nodes. Each one is associated with a particular sensor. ![SDFNODES](https://help.polysync.io/releases/2.0.8//wp-content/uploads/2016/11/replay2.png) ### 7. Replay module To replay a logfile session, open the logfile manager window with the icon. Drag logfile session 1000 from the logfile manager on the left, to the playlist on the right. When you double-click on Session 1000, all nodes in that logfile session synchronize their start time and playback begins. When you press play, you should see the logfile data show up in the 3D View plugin. ![Logfile Session 1000 Playback](https://help.polysync.io/releases/2.0.8//wp-content/uploads/2016/11/studio-logfile-5.png) ### Conclusion Congratulations! You have now successfully downloaded and installed PolySync, worked through opening Studio and replaying data. Your system is now ready to do some heavy lifting. We recommend reviewing the [available workflows](https://help.polysync.io/releases/2.0.8//articles/polysync-workflows/).