rise-origin

Quick start ​

This tutorial builds rise-origin from source on Linux and opens a window with a pile of rigid and soft boxes. The first build compiles the engine and its libraries and takes most of the time.

Before you start, your machine needs:

  • Linux on x86_64 with an NVIDIA GPU from Volta to Hopper, or a newer one with the cuda13 backend.
  • The CUDA toolkit, with nvcc on your PATH.
  • Python 3.10 or newer, CMake 3.22 or newer, a C++ compiler, nasm and meson.

Build the engine ​

  1. Clone the repository and enter it:

    bash
    git clone https://github.com/iffiX/rise-origin
cd rise-origin

  2. Create a virtual environment and activate it:

    bash
    python3 -m venv venv
source venv/bin/activate

  3. Install the engine's GPU backend and the Python package. This step compiles the engine:

    bash
    pip install ./rise_origin/cuda12 .

  4. Confirm that the package imports:

    bash
    python -c "import rise_origin; print(rise_origin.__file__)"

    The command prints a path inside your virtual environment.

Run a world ​

  1. Run the first example:

    bash
    python examples/basic/boxes.py

    A window opens, and sixteen rigid and soft boxes fall and settle into a pile.

  2. Close the window, then record the same world to a video:

    bash
    RISE_MODE=record RISE_OUT=boxes.mp4 RISE_DURATION=4 python examples/basic/boxes.py

    The script opens no window and writes boxes.mp4 when four seconds of the world have passed.