Installation

Base install

Install the core package with:

pip install pyshmem

For local development from a checkout:

pip install -e .

Optional dependencies

Testing tools:

pip install -e .[test]

CUDA-backed GPU support:

pip install -e .[gpu]

Documentation build dependencies:

pip install -e .[docs]

Requirements

  • Python 3.9 or newer

  • NumPy 1.26 or newer

  • PyTorch with CUDA support if you want GPU streams

To confirm GPU availability inside your environment:

import pyshmem
print(pyshmem.gpu_available())