Installation Guide

This page describes installation of NLCPy.

Attention

  • Since April 2021, NLCPy has been provided as a software of NEC SDK (NEC Software Development Kit for Vector Engine). If NEC SDK on your machine has been properly installed or updated after that, NLCPy is available by using /usr/bin/python3 command, and the installation described in this page is not needed. However, when you use another Python command such as /usr/local/bin/python3 and python3 in a virtual environment, please install NLCPy from a wheel package or source files described in this page.

See also

SX-Aurora TSUBASA Installation Guide

  • The libraries of NLCPy are located in the following directory after NEC SDK is installed or updated:

    /opt/nec/ve/nlcpy/X.X.X/lib/python36/nlcpy

    Here, X.X.X denotes the version of NLCPy. If you install or update NEC SDK, the directory of the latest version of NLCPy is added in Python module search path. When you use a specific version of NLCPy, the evironmental variable PYTHONPATH must be set as follows:

    $ export PYTHONPATH=/opt/nec/ve/nlcpy/X.X.X/lib/python36/

Requirements

Before the installation of NLCPy, the following components are required to be installed on your x86 Node of SX-Aurora TSUBASA.

  • NEC SDK

    • required NEC C/C++ compiler version: >= 5.0.0

    • required NLC version: >= 3.0.0

  • Alternative VE Offloading (AVEO)

    • required version: >= 3.0.2

    • If you install NLCPy from wheel, the runtime packages of Alternative VE Offloading(AVEO) are required.

      # yum install veoffload-aveo veoffload-aveorun-ve1 veoffload-aveorun-ve3

    • If you install NLCPy from source, the development packages of Alternative VE Offloading(AVEO) are required.

      # yum install veoffload-aveo-devel veoffload-aveorun-ve1-devel veoffload-aveorun-ve3-devel
  • veosinfo3
    # yum install veosinfo3
  • Python

    • required version: 3.6, 3.7, or 3.8

  • NumPy

    • required version: >= v1.17

Install from wheel

You can install NLCPy by executing either of following commands.

  • Install from PyPI

    $ pip install nlcpy

  • Install from your local computer

    1. Download the wheel package from GitHub.

    2. Put the wheel package to your any directory.

    3. Install the local wheel package via pip command.

      $ pip install <path_to_wheel>

The shared objects for Vector Engine, which are included in the wheel package, are tested by using NEC C/C++ Compiler Version 5.0.0 and NumPy v1.19.5.

Install from source (with building)

Before building source files, please install following packages.

$ pip install numpy cython wheel
$ sudo yum install veosinfo3-devel
$ sudo yum install veoffload-aveo-devel veoffload-aveorun-ve1-devel veoffload-aveorun-ve3-devel

And, entering the following commands in the environment where gcc and ncc commands are available.

$ git clone https://github.com/SX-Aurora/nlcpy.git
$ cd nlcpy
$ python3 setup.py build_ext --targ ve1,ve3,vh
$ python3 setup.py intall --targ ve1,ve3,vh