Skip to content

Commit

Permalink
Merge branch 'github-pull-221' into 'main'
Browse files Browse the repository at this point in the history
GitHub Merge Request 221

See merge request omniverse/warp!527
  • Loading branch information
mmacklin committed May 31, 2024
2 parents 7071220 + 0382a30 commit 5df5f44
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ The easiest way to install Warp is from [PyPI](https://pypi.org/project/warp-lan

pip install warp-lang

You can also use `pip install warp-lang[extras]` to install additional dependencies for running examples and USD-related features.

Pre-built binary packages are also available on the [Releases](https://github.com/NVIDIA/warp/releases) page. To install in your local Python environment run the following command from the download directory:

pip install warp_lang-<version and platform>.whl
Expand Down Expand Up @@ -71,6 +73,10 @@ print(lengths)

The `examples` directory contains a number of scripts that show how to implement different simulation methods using the Warp API. Most examples will generate USD files containing time-sampled animations (stored in the current working directory). Before running examples, users should ensure that the ``usd-core``, ``matplotlib``, and ``pyglet`` packages are installed using:

pip install warp-lang[extras]

Or can be manually installed with:

pip install usd-core matplotlib pyglet

Examples can be run from the command-line as follows:
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Changelog = "https://github.com/NVIDIA/warp/blob/main/CHANGELOG.md"

[project.optional-dependencies]
dev = ["pre-commit", "ruff", "nvtx", "furo", "sphinx-copybutton", "coverage[toml]"]
extras = ['usd-core', 'matplotlib', 'pyglet']

[tool.setuptools.packages.find]
include = ["warp*"]
Expand Down

0 comments on commit 5df5f44

Please sign in to comment.