Skip to content

isabella232/Unity-Simulation-Docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Unity Simulation Documentation

Welcome and thanks for using Unity Simulation. Unity Simulation enables product developers, researchers, and engineers to easily and efficiently run thousands of instances of parameterized Unity builds in batch in the cloud. Unity Simulation allows you to parameterize a Unity project in ways that will change from run to run. You can also specify simulation output data necessary for your end application, whether that be the generation of training data for machine learning, the testing and validation of AI algorithms, or the evaluation and optimization of modeled systems. With Unity Simulation, there is no need to install and manage batch computing software or server clusters that you use to run your jobs, allowing you to focus on analyzing results and solving problems.

We hope you enjoy using the service, if you have any questions please open a thread in the forum or contact support at simulation-help@unity3d.com.

Pre-Requisites to installing Unity Simulation

You should install a compatible version of Unity that is listed below. Please make sure to include linux build support in your installation.

  • Unity Account
  • Unity Cloud Project
  • Unity version >= 2018.4 (>= 2019.3 for SRP support)
  • Supported Graphics APIs: OpenGL (upto 3.3)
  • Supported platforms: Windows10+ and OS X 10.13+
  • Linux build support required

Please refer to the Installing pre-requisites guide for a step by side guide to installing the above pre-requisites.

Getting started with Unity Simulation

Section Description
Unity Simulation Concepts Unity Simulation Concepts
QuickStart tutorial How to get started with Unity Simulation - A walkthrough
Sample Smart-Camera-Outdoor Sample unity project demonstrating usage of simulation packages for outdoor smart camera usecases.
Sample Roll-A-Ball tutorial Sample unity project integrated with the Unity Simulation SDK
Warehouse Robotics Sample unity warehouse robotics project demonstrating usage of Unity Simulation and Perception SDK.

Developing a Simulation

Section Description
Unity Simulation SDK Developing with the Unity Simulation SDK
Unity Linux build How to make a Linux build
Linux Build Testing Testing Linux build locally

How-to Guides

Section Description
Use Case How-tos Example use cases and how to implement them.
Simultaneous Capture How to simultaneously log data and capture an image.
Cloud Data Transfer Transfer USim data to your cloud.
Troubleshooting Troubleshooting common issues.

Current Limitations

  • Currently USim only supports CPU based rendering via XVFB which means it is restricted to OpenGL version supported by mesa software renderer llvmpipe (i.e upto version 3.3).
  • Rendering pipelines: With OpenGL Gfx API you can run your project with built-in/legacy rendering pipeline or Universal Rendering Pipeline. High Definition Rendering Pipeline (HDRP) is currently not supported as it requires Vulkan or DirectX Gfx API.
  • Texture compression supported by Unity is not supported by the software renderer used in the cloud (llvmpipe). Instructions on disabling texture compression can be found here
  • Simulation runtime in the cloud needs to be LinuxStandalone.
  • Running simulation workload with GPUs is not currently supported.

Reference

Section Description
API Docs Documentation for using the Simulation API
CLI commands command descriptions for the CLI

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 94.8%
  • ShaderLab 5.2%