nlcpy 1.0.0

NLCPy is a package for accelerating performance of Python scripts using NumPy on SX-Aurora TSUBASA.

NLCPy : NumPy-like API accelerated with SX-Aurora TSUBASA

NLCPy is a library for accelerating performance of Python scripts using NumPy on SX-Aurora TSUBASA. Python programmers can use this library on Linux/x86 of SX-Aurora TSUBASA. NLCPy's API is designed based on NumPy's one. The current version provides a subset of NumPy's API.

Requirements

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

• NEC SDK

  • required NEC C/C++ compiler version: >= 3.1.1
  • required NLC version: >= 2.2.0

• Alternative VE Offloading (AVEO)

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

    # yum install veoffload-aveo veoffload-aveorun
    

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

    # yum install veoffload-aveo-devel veoffload-aveorun-devel
    

• Python - required version: 3.6, 3.7, or 3.8

• NumPy - required version: v1.17, v1.18, v1.19, or v1.20

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 compiled and tested by using NEC C/C++ Version 3.1.1 and NumPy v1.17.4.

Install from source (with building)

Before building source files, please install following packages.

$ pip install numpy cython wheel

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

$ git clone https://github.com/SX-Aurora/nlcpy.git
$ cd nlcpy
$ pip install .

Documentation

• NLCPy User's Guide

License

The BSD-3-Clause license (see LICENSE file).

NLCPy is derived from NumPy, CuPy, PyVEO, and numpydoc (see LICENSE_DETAIL/LICENSE_DETAIL file).