Skip to main content

DSX Air SDK

This project provides a Python SDK for interacting with the NVIDIA DSX Air API.

Documentation

For the full SDK documentation, please refer to the SDK page on NVIDIA docs.

For tutorials and code examples, please refer to the examples README in the docs directory. There you will find Jupyter notebooks covering various SDK features such as ZTP scripts and simulation import/export.

Prerequisite

The SDK requires Python 3.10. There are a number of ways to achieve this such as poetry, uv or virtualenv. The following shows how to achieve this on a few popular OS's using virtualenv.

# Install Python 3.10
brew install python@3.10  # MacOS
apt-get install python3.10  # Ubuntu/Debian
sudo pacman -S python310  # Arch

# Install, create and activate a Python 3.10 virtual environment
python3.10 -m pip install virtualenv
python3.10 -m virtualenv venv
. venv/bin/activate

Installation

pip install nv-air-sdk

Authentication Options

  1. NGC Device Login with AirApi.with_device_login(email=<YOUR_EMAIL>, org_num=<YOUR_NGC_ORG_NUMBER>)
  2. NGC CLI Login with AirApi.with_ngc_config() (or just AirApi())
  3. Explicitly specify an NGC API Key (also known as a Starfleet API Key, or "SAK") by instantiating AirApi.with_api_key(api_key=<YOUR_STARFLEET_API_KEY>)

And to use option 2 you will need to have the NGC CLI installed and to have configured it with ngc config set. This will create a file at ~/.ngc/config which contains your NGC credentials that will be auto-detected by the Air SDK.

License

MIT License - see LICENSE file for details

This project will download and install additional third-party open source software projects. Review the license terms of these open source projects before use.

Contributing

This project is currently not accepting contributions.

Metadata

Release files for nv-air-sdk 1.12.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for nv-air-sdk 1.12.0
File Interpreter ABI Platform Actions
nv_air_sdk-1.12.0-py3-none-any.whl Python 3 none any Details for nv_air_sdk-1.12.0-py3-none-any.whl

Release files / nv_air_sdk-1.12.0-py3-none-any.whl

Download URL nv_air_sdk-1.12.0-py3-none-any.whl
Size 215.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6d5206bdebbb74cd3beded970ad465a17220d7ce67636286281b20e515be1208
BLAKE2b-256 checksum
How to use checksums
699256a02518fe36670ca83ce4b57c5be09f7239f208476e9f4780f542d1649a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8

Security for nv-air-sdk 1.12.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page