Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 2.82 KB

pc.md

File metadata and controls

69 lines (48 loc) · 2.82 KB
Raw
Setup

Setup TDW on a PC (Linux, MacOS, Windows)

If you want to run a TDW Python controller on a local desktop and the build on a remote server, read this instead.

You can run TDW on a Linux, MacOS, or Windows person computer. If you have the required hardware, this is almost always easier to set up than a server; it is often useful to run TDW on a PC where it's easier to troubleshoot problems before moving it to a remote server.

System Requirements

  • Linux (we've tested TDW on Ubuntu 18, 20, and 22), MacOS (Sierra or newer), Windows 10 or 11
  • Python 3.8+
  • A GPU, the faster the better, with up-to-date drivers. It is possible to run TDW without a GPU but you will lose some speed and photorealism. NVIDIA drivers tend to work better,
  • For audio simulations, you will need an audio driver; unless you're running a minimal Linux install, you probably already have this.

Why does TDW need a GPU?

TDW runs on Unity3D, a video game engine. Unity's rendering looks more photorealistic if the computer has a GPU. Without a GPU, Unity cannot render as realistically and rendering will be slower. Unity also offloads many physics calculations to the GPU; without a GPU, Unity's physics will be slower.

Install

  1. pip3 install tdw
  2. Create this Python script and run it:
from tdw.controller import Controller

c = Controller()
print("Hello world!")
c.communicate({"$type": "terminate"})

Result: The terminal window will print messages about downloading a build. Then, it will launch a windowed application, print Hello world!, kill the windowed application process, and exit.

  1. Test image capture:
from tdw.controller import Controller
from tdw.tdw_utils import TDWUtils
from tdw.add_ons.third_person_camera import ThirdPersonCamera
from tdw.add_ons.image_capture import ImageCapture
from tdw.backend.paths import EXAMPLE_CONTROLLER_OUTPUT_PATH

camera = ThirdPersonCamera(position={"x": 2, "y": 1.6, "z": -0.6},
                           avatar_id="a",
                           look_at={"x": 0, "y": 0, "z": 0})
path = EXAMPLE_CONTROLLER_OUTPUT_PATH.joinpath("image_capture")
print(f"Images will be saved to: {path}")
capture = ImageCapture(avatar_ids=["a"], path=path)

c = Controller()
c.add_ons.extend([camera, capture])
object_id = c.get_unique_id()
commands = [TDWUtils.create_empty_room(12, 12)]
commands.extend(c.get_add_physics_object(model_name="iron_box",
                                         position={"x": 0, "y": 0, "z": 0},
                                         object_id=object_id))
c.communicate(commands)
c.communicate({"$type": "terminate"})

Result:

Troubleshooting

See this list of common problems. If you don't see your problem on the list, let us know by opening a GitHub Issue.