Skip to content
OmniGibson Documentation
Scripts
Initializing search
StanfordVL/OmniGibson
Home
Getting Started
API Reference
OmniGibson Documentation
StanfordVL/OmniGibson
Home
Getting Started
Getting Started
Installation
Quickstart
Building Blocks
API Reference
API Reference
macros
simulator
transition_rules
Controllers
Controllers
controller_base
dd_controller
ik_controller
joint_controller
multi_finger_gripper_controller
null_joint_controller
Envs
Envs
env_base
Examples
Examples
Environments
Environments
behavior_env_demo
navigation_env_demo
Learning
Learning
navigation_policy_demo
Object states
Object states
attachment_demo
dicing_demo
folded_unfolded_state_demo
heat_source_or_sink_demo
heated_state_demo
object_state_texture_demo
onfire_demo
overlaid_demo
particle_applier_remover_demo
particle_source_sink_demo
sample_kinematics_demo
slicing_demo
temperature_demo
Objects
Objects
draw_bounding_box
highlight_objects
load_object_selector
visualize_object
Renderer settings
Renderer settings
renderer_settings_example
Robots
Robots
all_robots_visualizer
grasping_mode_example
robot_control_example
Advanced
Advanced
ik_example
Scenes
Scenes
scene_selector
scene_tour_demo
traversability_map_example
Simulator
Simulator
sim_save_load_example
Maps
Maps
map_base
segmentation_map
traversable_map
Object states
Object states
aabb
adjacency
attached_to
burnt
contact_bodies
contact_particles
contact_subscribed_state_mixin
cooked
covered
factory
filled
folded
frozen
heat_source_or_sink
heated
inside
joint_break_subscribed_state_mixin
kinematics
link_based_state_mixin
max_temperature
next_to
object_state_base
on_fire
on_top
open
overlaid
particle_modifier
particle_source_or_sink
pose
saturated
sliced
slicer
temperature
toggle
touching
under
unfolded
update_state_mixin
water_sink
water_source
Objects
Objects
controllable_object
dataset_object
light_object
object_base
primitive_object
stateful_object
usd_object
Prims
Prims
cloth_prim
entity_prim
geom_prim
joint_prim
material_prim
prim_base
rigid_prim
xform_prim
Renderer settings
Renderer settings
common_settings
path_tracing_settings
post_processing_settings
real_time_settings
renderer_settings
settings_base
Reward functions
Reward functions
collision_reward
point_goal_reward
potential_reward
reaching_goal_reward
reward_function_base
Robots
Robots
active_camera_robot
fetch
freight
husky
locobot
locomotion_robot
manipulation_robot
robot_base
tiago
turtlebot
two_wheel_robot
Scenes
Scenes
interactive_traversable_scene
scene_base
static_traversable_scene
traversable_scene
Scripts
Scripts
Table of contents
scripts.setup
Sensors
Sensors
dropout_sensor_noise
scan_sensor
sensor_base
sensor_noise_base
vision_sensor
Systems
Systems
macro_particle_system
micro_particle_system
system_base
Tasks
Tasks
bddl_backend
behavior_task
dummy_task
point_navigation_task
point_reaching_task
task_base
Termination conditions
Termination conditions
falling
max_collision
point_goal
predicate_goal
reaching_goal
termination_condition_base
timeout
Utils
Utils
asset_utils
config_utils
constants
control_utils
deprecated_utils
geometry_utils
git_utils
gym_utils
object_state_utils
physx_utils
processing_utils
python_utils
registry_utils
render_utils
sampling_utils
sim_utils
transform_utils
ui_utils
usd_utils
vision_utils
Wrappers
Wrappers
wrapper_base
Table of contents
scripts.setup
setup
Helper script to setup this OmniGibson repository. Configures environment and downloads assets