# NVSHMEM

**Repository Path**: mirrors_NVIDIA/NVSHMEM

## Basic Information

- **Project Name**: NVSHMEM
- **Description**: NVIDIA NVSHMEM is a parallel programming interface for NVIDIA GPUs based on OpenSHMEM. NVSHMEM can significantly reduce multi-process communication and coordination overheads by allowing programmers to perform one-sided communication from within CUDA kernels and on CUDA streams.
- **Primary Language**: Unknown
- **License**: BSD-2-Clause
- **Default Branch**: devel
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-09
- **Last Updated**: 2026-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

NVSHMEM Overview
****************

NVSHMEM™ is a parallel programming interface based on OpenSHMEM that provides efficient and
scalable communication for NVIDIA GPU clusters. NVSHMEM creates a global address space for
data that spans the memory of multiple GPUs and can be accessed with fine-grained 
GPU-initiated operations, CPU-initiated operations, and operations on CUDA® streams.

Quick Links
****************

Please see the following public links for information on building and working wih NVSHMEM:

[Project Homepage](https://developer.nvidia.com/nvshmem)

[Release Notes](https://docs.nvidia.com/nvshmem/release-notes-install-guide/release-notes/index.html)

[Installation Guide](https://docs.nvidia.com/nvshmem/release-notes-install-guide/install-guide/index.html)

[Best Practice Guide](https://docs.nvidia.com/nvshmem/release-notes-install-guide/best-practice-guide/index.html)

[API Documentation](https://docs.nvidia.com/nvshmem/api/index.html)

[Devzone Topic Page](https://forums.developer.nvidia.com/tag/nvshmem)

The maintainers of the NVSHMEM project can also be contacted by e-mail at nvshmem@nvidia.com

Configuration file
******************

NVSHMEM options can be provided via a simple config file using `KEY=VALUE` syntax.

Config files are loaded in the following order (later files override earlier files):

- `/etc/nvshmem.conf`
- `~/.nvshmem.conf`
- The file pointed to by `NVSHMEM_CONF_FILE`

If a key is present in any loaded config file, its value **overrides the corresponding environment
variable**.

Example:

```
# Example /etc/nvshmem.conf file
NVSHMEM_DEBUG=WARN
# NVSHMEM_SOME_FLAG=1 # This line is a comment and would be ignored.
```