logoNeutrino

System Entry and CLI

Python Package Installation

neutrino is packaged as an Python package available through python setup.py install.

Requirements

  • OS: Linux, with git, file and LD_PRELOAD available
  • Python: 3.10 or higher, with toml as only dependencis
  • Compiler: a C compiler, most works like gcc 11.4.0, self-contained with all dependencies header-only
  • Platform toolkit and binutils:
    • CUDA: cuda.h, libcuda.so, cuobjdump, ptxas
    • ROCm: hip/hip_runtime.h, libamdhip.so, roc-obj-extract, hipcc

Install from source code

Use Virtual Environment!

Please use neutrino in virtual environments such as conda aka conda create -y -n <name> python=3.11 && conda activate <name> before moving on.

As the project is still in preview, please install from source via:

git clone https://github.com/neutrino-gpu/neutrino
cd neutrino && python setup.py install && cd ..

Please note pip install neutrino will install another old project! We're still working with pip installation.

You can verify the installation via:

neutrino --help

Install Release Version

We don't currently have plans for installing from pip or other source, for two reasons:

  1. For maximum compatibility with different drivers/versions, many Neutrino codes are auto-generated from parsing headers and driver's symbol tables.
  2. Neutrino's building time is acceptable (less than 10 second).
  3. neutrino's keyword has been taken by another project in 2013...

Docker Image Installation

System Workflow Overview

Previous Page

Hook Driver

Next Page