warp-lang 1.2.1__py3-none-macosx_10_13_universal2.whl → 1.3.0__py3-none-macosx_10_13_universal2.whl

warp/utils.py

@@ -644,6 +644,7 @@ class ScopedTimer:
             skip_tape (bool): If true, the timer will not be recorded in the tape
 
         Attributes:
+            extra_msg (str): Can be set to a string that will be added to the printout at context exit.
             elapsed (float): The duration of the ``with`` block used with this object
             timing_results (list[TimingResult]): The list of activity timing results, if collection was requested using ``cuda_filter``
         """
@@ -659,6 +660,7 @@ class ScopedTimer:
         self.elapsed = 0.0
         self.cuda_filter = cuda_filter
         self.report_func = report_func or wp.timing_print
+        self.extra_msg = ""  # Can be used to add to the message printed at manager exit
 
         if self.dict is not None:
             if name not in self.dict:
@@ -688,6 +690,10 @@ class ScopedTimer:
             if self.print:
                 ScopedTimer.indent += 1
 
+                if warp.config.verbose:
+                    indent = "    " * ScopedTimer.indent
+                    print(f"{indent}{self.name} ...", flush=True)
+
             self.start = time.perf_counter_ns()
 
         return self
@@ -720,13 +726,16 @@ class ScopedTimer:
                 self.dict[self.name].append(self.elapsed)
 
             if self.print:
-                indent = "\t" * ScopedTimer.indent
+                indent = "    " * ScopedTimer.indent
 
                 if self.timing_results:
                     self.report_func(self.timing_results, indent=indent)
                     print()
 
-                print(f"{indent}{self.name} took {self.elapsed :.2f} ms")
+                if self.extra_msg:
+                    print(f"{indent}{self.name} took {self.elapsed :.2f} ms {self.extra_msg}")
+                else:
+                    print(f"{indent}{self.name} took {self.elapsed :.2f} ms")
 
                 ScopedTimer.indent -= 1
 

{warp_lang-1.2.1.dist-info → warp_lang-1.3.0.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: warp-lang
-Version: 1.2.1
+Version: 1.3.0
 Summary: A Python framework for high-performance simulation and graphics programming
-Author-email: NVIDIA <mmacklin@nvidia.com>
+Author-email: NVIDIA Corporation <mmacklin@nvidia.com>
 License: NVIDIA Software License
 Project-URL: GitHub, https://github.com/NVIDIA/warp
 Project-URL: Documentation, https://nvidia.github.io/warp
@@ -34,7 +34,7 @@ Requires-Dist: pyglet ; extra == 'extras'
 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/NVIDIA/warp?link=https%3A%2F%2Fgithub.com%2FNVIDIA%2Fwarp%2Fcommits%2Fmain)
 [![Downloads](https://static.pepy.tech/badge/warp-lang/month)](https://pepy.tech/project/warp-lang)
 [![codecov](https://codecov.io/github/NVIDIA/warp/graph/badge.svg?token=7O1KSM79FG)](https://codecov.io/github/NVIDIA/warp)
-![GitHub - Build and Test](https://github.com/NVIDIA/warp/actions/workflows/build-and-test.yml/badge.svg)
+![GitHub - CI](https://github.com/NVIDIA/warp/actions/workflows/ci.yml/badge.svg)
 [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.com/invite/nvidiaomniverse)
 
 # NVIDIA Warp
@@ -42,7 +42,8 @@ Requires-Dist: pyglet ; extra == 'extras'
 Warp is a Python framework for writing high-performance simulation and graphics code. Warp takes
 regular Python functions and JIT compiles them to efficient kernel code that can run on the CPU or GPU.
 
-Warp is designed for spatial computing and comes with a rich set of primitives that make it easy to write
+Warp is designed for [spatial computing](https://en.wikipedia.org/wiki/Spatial_computing)
+and comes with a rich set of primitives that make it easy to write
 programs for physics simulation, perception, robotics, and geometry processing. In addition, Warp kernels
 are differentiable and can be used as part of machine-learning pipelines with frameworks such as PyTorch and JAX.
 
@@ -60,19 +61,54 @@ GPU support requires a CUDA-capable NVIDIA GPU and driver (minimum GeForce GTX 9
 
 The easiest way to install Warp is from [PyPI](https://pypi.org/project/warp-lang/):
 
-    pip install warp-lang
+```text
+pip install warp-lang
+```
 
 You can also use `pip install warp-lang[extras]` to install additional dependencies for running examples and USD-related features.
 
-The binaries hosted on PyPI are currently built with the CUDA 11.8 runtime.
-We provide binaries built with the CUDA 12.5 runtime on the [GitHub Releases](https://github.com/NVIDIA/warp/releases) page.
+The binaries hosted on PyPI are currently built with the CUDA 12 runtime and therefore
+require a minimum version of the CUDA driver of 525.60.13 (Linux x86-64) or 528.33 (Windows x86-64).
+
+If you require GPU support on a system with an older CUDA driver, you can build Warp from source or
+install wheels built with the CUDA 11.8 runtime from the [GitHub Releases](https://github.com/NVIDIA/warp/releases) page.
 Copy the URL of the appropriate wheel file (`warp-lang-{ver}+cu12-py3-none-{platform}.whl`) and pass it to
 the `pip install` command, e.g.
 
-    pip install https://github.com/NVIDIA/warp/releases/download/v1.2.0/warp_lang-1.2.0+cu12-py3-none-manylinux2014_x86_64.whl
+| Platform        | Install Command                                                                                                               |
+| --------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| Linux aarch64   | `pip install https://github.com/NVIDIA/warp/releases/download/v1.3.0/warp_lang-1.3.0+cu11-py3-none-manylinux2014_aarch64.whl` |
+| Linux x86-64    | `pip install https://github.com/NVIDIA/warp/releases/download/v1.3.0/warp_lang-1.3.0+cu11-py3-none-manylinux2014_x86_64.whl`  |
+| Windows x86-64  | `pip install https://github.com/NVIDIA/warp/releases/download/v1.3.0/warp_lang-1.3.0+cu11-py3-none-win_amd64.whl`             |
 
 The `--force-reinstall` option may need to be used to overwrite a previous installation.
 
+### CUDA Requirements
+
+* Warp packages built with CUDA Toolkit 11.x require NVIDIA driver 470 or newer.
+* Warp packages built with CUDA Toolkit 12.x require NVIDIA driver 525 or newer.
+
+This applies to pre-built packages distributed on PyPI and GitHub and also when building Warp from source.
+
+Note that building Warp with the `--quick` flag changes the driver requirements.  The quick build skips CUDA backward compatibility, so the minimum required driver is determined by the CUDA Toolkit version.  Refer to the [latest CUDA Toolkit release notes](https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/index.html) to find the minimum required driver for different CUDA Toolkit versions (e.g., [this table from CUDA Toolkit 12.5](https://docs.nvidia.com/cuda/archive/12.5.0/cuda-toolkit-release-notes/index.html#id3)).
+
+Warp checks the installed driver during initialization and will report a warning if the driver is not suitable, e.g.:
+
+```text
+Warp UserWarning:
+   Insufficient CUDA driver version.
+   The minimum required CUDA driver version is 12.0, but the installed CUDA driver version is 11.8.
+   Visit https://github.com/NVIDIA/warp/blob/main/README.md#installing for guidance.
+```
+
+This will make CUDA devices unavailable, but the CPU can still be used.
+
+To remedy the situation there are a few options:
+
+* Update the driver.
+* Install a compatible pre-built Warp package.
+* Build Warp from source using a CUDA Toolkit that's compatible with the installed driver.
+
 ## Getting Started
 
 An example first program that computes the lengths of random 3D vectors is given below:
@@ -108,20 +144,32 @@ print(lengths)
 
 ## Running Examples
 
-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).
+The [warp/examples](./warp/examples/) directory contains a number of scripts categorized under subdirectories
+that show how to implement various simulation methods using the Warp API.
+Most examples will generate USD files containing time-sampled animations 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
+```text
+pip install warp-lang[extras]
+```
+
+These dependencies can also be manually installed using:
+
+```text
+pip install usd-core matplotlib pyglet
+```
 
 Examples can be run from the command-line as follows:
 
-    python -m warp.examples.<example_subdir>.<example>
+```text
+python -m warp.examples.<example_subdir>.<example>
+```
 
 To browse the example source code, you can open the directory where the files are located like this:
 
-    python -m warp.examples.browse
+```text
+python -m warp.examples.browse
+```
 
 Most examples can be run on either the CPU or a CUDA-capable device, but a handful require a CUDA-capable device. These are marked at the top of the example script.
 
@@ -129,10 +177,11 @@ USD files can be viewed or rendered inside [NVIDIA Omniverse](https://developer.
 
 Built-in unit tests can be run from the command-line as follows:
 
-    python -m warp.tests
-
+```text
+python -m warp.tests
+```
 
-### examples/core
+### warp/examples/core
 
 <table>
     <tbody>
@@ -175,40 +224,38 @@ Built-in unit tests can be run from the command-line as follows:
     </tbody>
 </table>
 
-
-### examples/fem
+### warp/examples/fem
 
 <table>
     <tbody>
         <tr>
-            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_apic_fluid.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_apic_fluid.png"></a></td>
-            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_convection_diffusion.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_convection_diffusion.png"></a></td>
             <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_diffusion_3d.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_diffusion_3d.png"></a></td>
-            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_diffusion.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_diffusion.png"></a></td>
+            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_mixed_elasticity.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_mixed_elasticity.png"></a></td>
+            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_apic_fluid.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_apic_fluid.png"></a></td>
+            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_streamlines.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_streamlines.png"></a></td>
         </tr>
         <tr>
-            <td align="center">apic fluid</td>
-            <td align="center">convection diffusion</td>
             <td align="center">diffusion 3d</td>
-            <td align="center">diffusion</td>
+            <td align="center">mixed elasticity</td>
+            <td align="center">apic fluid</td>
+            <td align="center">streamlines</td>
         </tr>
         <tr>
-            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_mixed_elasticity.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_mixed_elasticity.png"></a></td>
+            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_convection_diffusion.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_convection_diffusion.png"></a></td>
             <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_navier_stokes.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_navier_stokes.png"></a></td>
-            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_stokes_transfer.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_stokes_transfer.png"></a></td>
-            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_stokes.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_stokes.png"></a></td>
+            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_burgers.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_burgers.png"></a></td>
+            <td><a href="https://github.com/NVIDIA/warp/tree/main/warp/examples/fem/example_magnetostatics.py"><img src="https://github.com/NVIDIA/warp/raw/main/docs/img/examples/fem_magnetostatics.png"></a></td>
         </tr>
         <tr>
-            <td align="center">mixed elasticity</td>
+            <td align="center">convection diffusion</td>
             <td align="center">navier stokes</td>
-            <td align="center">stokes transfer</td>
-            <td align="center">stokes</td>
+            <td align="center">burgers</td>
+            <td align="center">magnetostatics</td>
         </tr>
     </tbody>
 </table>
 
-
-### examples/optim
+### warp/examples/optim
 
 <table>
     <tbody>
@@ -239,8 +286,7 @@ Built-in unit tests can be run from the command-line as follows:
     </tbody>
 </table>
 
-
-### examples/sim
+### warp/examples/sim
 
 <table>
     <tbody>
@@ -283,7 +329,6 @@ Built-in unit tests can be run from the command-line as follows:
     </tbody>
 </table>
 
-
 ## Building
 
 For developers who want to build the library themselves, the following tools are required:
@@ -295,11 +340,19 @@ For developers who want to build the library themselves, the following tools are
 
 After cloning the repository, users should run:
 
-    python build_lib.py
+```text
+python build_lib.py
+```
 
-This will generate the `warp.dll` / `warp.so` core library respectively. It will search for the CUDA Toolkit in the default install directory. This path can be overridden by setting the `CUDA_PATH` environment variable. Alternatively, the path to the CUDA Toolkit can be passed to the build command as `--cuda_path="..."`. After building, the Warp package should be installed using:
+Upon success, the script will output platform-specific binary files in `warp/bin/`.
+The build script will look for the CUDA Toolkit in its default installation path.
+This path can be overridden by setting the `CUDA_PATH` environment variable. Alternatively,
+the path to the CUDA Toolkit can be passed to the build command as
+`--cuda_path="..."`. After building, the Warp package should be installed using:
 
-    pip install -e .
+```text
+pip install -e .
+```
 
 This ensures that subsequent modifications to the library will be reflected in the Python package.
 
@@ -327,7 +380,7 @@ See the [FAQ](https://nvidia.github.io/warp/faq.html) in the Warp documentation.
 
 Problems, questions, and feature requests can be opened on [GitHub Issues](https://github.com/NVIDIA/warp/issues).
 
-The Warp team also monitors the **#warp** channel on the public [Omniverse Discord](https://discord.com/invite/nvidiaomniverse) server, come chat to us!
+The Warp team also monitors the **#warp** channel on the public [Omniverse Discord](https://discord.com/invite/nvidiaomniverse) server, come chat with us!
 
 ## Versioning
 
@@ -335,12 +388,12 @@ Versions take the format X.Y.Z, similar to [Python itself](https://devguide.pyth
 
 * Increments in X are reserved for major reworks of the project causing disruptive incompatibility (or reaching the 1.0 milestone).
 * Increments in Y are for regular releases with a new set of features.
-* Increments in Z are for bug fixes. In principle there are no new features. Can be omitted if 0 or not relevant.
+* Increments in Z are for bug fixes. In principle, there are no new features. Can be omitted if 0 or not relevant.
 
-This is similar to [Semantic Versioning](https://semver.org/) but less strict around backward compatibility.
-Like with Python, some breaking changes can be present between minor versions if well documented and gradually introduced.
+This is similar to [Semantic Versioning](https://semver.org/) but is less strict regarding backward compatibility.
+Like with Python, some breaking changes can be present between minor versions if well-documented and gradually introduced.
 
-Note that prior to 0.11.0 this schema was not strictly adhered to.
+Note that prior to 0.11.0, this schema was not strictly adhered to.
 
 ## License
 
@@ -349,12 +402,12 @@ Warp is provided under the NVIDIA Software License, please see [LICENSE.md](./LI
 ## Contributing
 
 Contributions and pull requests from the community are welcome and are taken under the
-terms described in the **9. Feedback** section of the [license](LICENSE.md).
+terms described in the **Feedback** section of [LICENSE.md](LICENSE.md#9-feedback).
 [CONTRIBUTING.md](./CONTRIBUTING.md) provides additional information on how to open a pull request for Warp.
 
 ## Citing
 
-If you use Warp in your research please use the following citation:
+If you use Warp in your research, please use the following citation:
 
 ```bibtex
 @misc{warp2022,