NeoPulse® INSTALLATION GUIDE

Product Version: 4

April 2021

The information in this publication is furnished for information use only, and does not constitute a commitment from AI Dynamics of any features or functions discussed. AI Dynamics assumes no responsibility or liability for the accuracy of the information presented, which is subject to change without notice. NeoPulse® is a registered trademark of AI Dynamics, Inc. The NeoPulse® logo and all other AI Dynamics product or service names and slogans are registered trademarks or trademarks of AI Dynamics, Inc. All other trademarks and registered trademarks are property of their respective owners.

Disclaimers

This document may contain information regarding the use and installation of non-NeoPulse® products. Please note that this information is provided as a courtesy to assist you. While AI Dynamics tries to ensure that this information accurately reflects the information provided by the supplier, please refer to the materials provided with any non-NeoPulse® product and contact the supplier for confirmation. AI Dynamics Inc, assumes no responsibility or liability for incorrect or incomplete information provided about non-NeoPulse® products.

1. INTRODUCTION

1.1. Overview

This guide provides detailed instructions on how to install and set up NeoPulse®. It lists all product requirements and guides you through the installation process. It also explains how to upgrade from the previous NeoPulse® versions. This guide can be used by system integrators and administrators.

1.2. How This Guide is Organized

  • Chapter 1 Introduction: the current chapter. It explains the purpose of this document, defines its audience and explains its structure.

  • Chapter 2 Installation Prerequisites: lists all product requirements, as well as requirements to the monitored environment.

  • Chapter 3 Installing NeoPulse® contains instructions on how to install NeoPulse®.

  • Chapter 4 Upgrading from Previous Versions contains instructions on how to upgrade from a previous version of NeoPulse®.

  • Chapter 5 Uninstalling NeoPulse® explains how to uninstall NeoPulse®.

2. INSTALLATION PREREQUISITES

This chapter lists all hardware and software requirements for the installation of NeoPulse®.

2.1. Hardware Requirements

Make sure that the computer for the NeoPulse® installation meets the following hardware requirements:

Table 1: NeoPulse® Hardware Requirements Component Minimum Recommended

Component
Minimum
Recommended
Processor
Dual Core Intel or AMD 32 bit, 2GHz
Quad core Intel or AMD 64 bit, 3GHz (2016 or later)
Memory
8GB RAM
16GB RAM
Disk
16GB physical disk space for the installation50GB for data and model storage
16GB physical disk space for the installation2TB for data and model storage
GPU compute capability (Only for GPU version)
3 TOPS
8+ TOPS

2.2. Software Requirements

Make sure that the computer for the NeoPulse® installation meets the following software requirements:

Table 2: Software Requirements

Component
Requirement
Operating System
Ubuntu 16.04, 18.04, or 20.04
Nvidia-driver
430.x or higher
Other
NeoPulse® will install software packages and libraries it requires to run during the installation process including the following:
  • apt-transport-https
  • ca-certificates
  • curl
  • gnupg-agent
  • software-properties-common
  • nvidia-container-runtime
  • nvidia-container-toolkit
  • docker-ce-19.03.12-3.el7
  • docker-ce-cli-19.03.12-3.el7
  • io-1.2.13-3.2.el7

    This list is subject to change with each new release and is current as of NeoPulse® Version 4
  • 3. INSTALLING NEOPULSE®

    To install NeoPulse®

    1. Run the setup package with the appropriate options (see Table 3):
      $ sudo ./install_neopulse_<Ubuntu version> -l <path/to/neopulse.license >

    2. Follow the onscreen instructions.

    3. (Optional) If any packages were installed that require it, the installer will instruct you to reboot the machine.
    4. If you did not reboot, please log out, log back in, and run:
      $ sudo neopulse start

    Table 3: Installation options:

    Options
    Description
    -h, --help
    Show help
    -l </path/to/neopulse.license>,
    --license </Ubuntu/path/to/neopulse.license>
    This is a required flag
    -f, --force
    When used along with --uninstall, stops, and uninstalls any NeoPulse® application that is previously installed on the system also deleting any user projects that is trained with the current application.

    When used along with --update, shuts down and uninstalls any NeoPulse® application but preserves any user projects that were created with the installed version. Then installs a new version that license file authorizes.

    When used along with --reinstall, shuts down, uninstalls along with removing any user projects and installs new version that license file authorizes.

    When used along with just license file, skips all the user confirmation steps in installation process.
    -v, --verbose
    Displays details of execution. This is an aggregation flag, which means the level of verbosity is set based on the number of time this flag is passed. Up to 2 '-vv' may be useful for the user beyond 2 occurrences are used for internal purposes.
    --version
    Displays version of the NeoPulse® installer.
    --uninstall
    Uninstalls NeoPulse® application.
    -u, --update
    Flag when set, will update the version of NeoPulse® that the license authorizes to install.
    --reinstall
    Flag when set, will uninstall the previous version of the NeoPulse® installed on the system and then install the version that the license authorize. NOTE: This will remove all user data from the system. Make sure to export any project that you wish to preserve.

    4. UPGRADING FROM PREVIOUS VERSIONS

    To upgrade NeoPulse® to the latest released version, do the following:

    1. Shutdown NeoPulse® by running:
      $ sudo neopulse shutdown
    2. Run the setup package with the "--update" flag:
      $ sudo ./install_neopulse_<Ubuntu version> -l <path/to/neopulse.license> --update
    3. Follow the onscreen instructions.
    4. Log out, log back in, and run:
      $ sudo neopulse start

    NeoPulse® will be updated automatically. After the upgrade, all the existing configuration settings and project data will be preserved for no re-configuration required.

    5. UNINSTALLING NEOPULSE®

    To uninstall NeoPulse®, do the following:

    1. Shutdown NeoPulse® by running:
      $ sudo neopulse shutdown
    2. Run the setup package the --uninstall flag:
      $ sudo ./install_neopulse_<Ubuntu version> --uninstall
    3. Follow the onscreen instructions.
    4. NeoPulse® will be uninstalled.

    NeoPulse® installtation guide © 2017-2021, AI Dynamics, Inc. All Rights Reserved.