Skip to content

Commit

Permalink
README.md examples links
Browse files Browse the repository at this point in the history
  • Loading branch information
shi-eric authored and c0d1f1ed committed Jun 14, 2024
1 parent cbbf9b8 commit 9c4a8e3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,10 @@ print(lengths)

## Running Examples

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:
The [warp/examples](./warp/examples/) directory contains a number of scripts categorized under different subdirectories
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 usd-core matplotlib pyglet

Expand Down
12 changes: 6 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,14 @@ An example first program that computes the lengths of random 3D vectors is given
Additional Examples
-------------------

The `examples <https://github.com/NVIDIA/warp/tree/main/warp/examples>`_ directory in
the Github repository contains a number of scripts that show how to
implement different simulation methods using the Warp API. Most examples
The `warp/examples <https://github.com/NVIDIA/warp/tree/main/warp/examples>`_ directory in
the Github repository contains a number of scripts categorized under different subdirectories
that show how to implement different simulation methods using the Warp API. Most examples
will generate USD files containing time-sampled animations in the
same directory as the example. Before running examples users should
ensure that the ``usd-core`` package is installed using::
same directory as the example.
Before running examples, users should ensure that the ``usd-core``, ``matplotlib``, and ``pyglet`` packages are installed using::

pip install usd-core
pip install usd-core matplotlib pyglet

Examples can be run from the command-line as follows::

Expand Down

0 comments on commit 9c4a8e3

Please sign in to comment.