isaaclab

Unified framework for robot learning built on NVIDIA Isaac Sim

https://github.com/isaac-sim/isaaclab

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    12 of 122 committers (9.8%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary

Keywords

isaac-sim omniverse-kit-extension robot-learning robotics
Last synced: 6 months ago · JSON representation

Repository

Unified framework for robot learning built on NVIDIA Isaac Sim

Basic Info
Statistics
  • Stars: 4,762
  • Watchers: 50
  • Forks: 2,268
  • Open Issues: 329
  • Releases: 17
Topics
isaac-sim omniverse-kit-extension robot-learning robotics
Created over 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Citation Codeowners Security

README.md

Isaac Lab


Isaac Lab

IsaacSim Python Linux platform Windows platform pre-commit docs status License License

Isaac Lab is a GPU-accelerated, open-source framework designed to unify and simplify robotics research workflows, such as reinforcement learning, imitation learning, and motion planning. Built on NVIDIA Isaac Sim, it combines fast and accurate physics and sensor simulation, making it an ideal choice for sim-to-real transfer in robotics.

Isaac Lab provides developers with a range of essential features for accurate sensor simulation, such as RTX-based cameras, LIDAR, or contact sensors. The framework's GPU acceleration enables users to run complex simulations and computations faster, which is key for iterative processes like reinforcement learning and data-intensive tasks. Moreover, Isaac Lab can run locally or be distributed across the cloud, offering flexibility for large-scale deployments.

Key Features

Isaac Lab offers a comprehensive set of tools and environments designed to facilitate robot learning:

  • Robots: A diverse collection of robots, from manipulators, quadrupeds, to humanoids, with 16 commonly available models.
  • Environments: Ready-to-train implementations of more than 30 environments, which can be trained with popular reinforcement learning frameworks such as RSL RL, SKRL, RL Games, or Stable Baselines. We also support multi-agent reinforcement learning.
  • Physics: Rigid bodies, articulated systems, deformable objects
  • Sensors: RGB/depth/segmentation cameras, camera annotations, IMU, contact sensors, ray casters.

Getting Started

Getting Started with Open-Source Isaac Sim

Isaac Sim is now open source and available on GitHub!

For detailed Isaac Sim installation instructions, please refer to Isaac Sim README.

  1. Clone Isaac Sim

    git clone https://github.com/isaac-sim/IsaacSim.git

  2. Build Isaac Sim

    cd IsaacSim ./build.sh

    On Windows, please use build.bat instead.

  3. Clone Isaac Lab

    cd .. git clone https://github.com/isaac-sim/IsaacLab.git cd isaaclab

  4. Set up symlink in Isaac Lab

    Linux:

    ln -s ../IsaacSim/_build/linux-x86_64/release _isaac_sim

    Windows:

    mklink /D _isaac_sim ..\IsaacSim\_build\windows-x86_64\release

  5. Install Isaac Lab

    Linux:

    ./isaaclab.sh -i

    Windows:

    isaaclab.bat -i

  6. [Optional] Set up a virtual python environment (e.g. for Conda)

    Linux:

    source _isaac_sim/setup_conda_env.sh

    Windows:

    _isaac_sim\setup_python_env.bat

  7. Train!

    Linux:

    ./isaaclab.sh -p scripts/reinforcement_learning/skrl/train.py --task Isaac-Ant-v0 --headless

    Windows:

    isaaclab.bat -p scripts\reinforcement_learning\skrl\train.py --task Isaac-Ant-v0 --headless

Documentation

Our documentation page provides everything you need to get started, including detailed tutorials and step-by-step guides. Follow these links to learn more about:

Isaac Sim Version Dependency

Isaac Lab is built on top of Isaac Sim and requires specific versions of Isaac Sim that are compatible with each release of Isaac Lab. Below, we outline the recent Isaac Lab releases and GitHub branches and their corresponding dependency versions for Isaac Sim.

| Isaac Lab Version | Isaac Sim Version | | ----------------------------- | ------------------- | | main branch | Isaac Sim 4.5 / 5.0 | | v2.2.X | Isaac Sim 4.5 / 5.0 | | v2.1.X | Isaac Sim 4.5 | | v2.0.X | Isaac Sim 4.5 |

Contributing to Isaac Lab

We wholeheartedly welcome contributions from the community to make this framework mature and useful for everyone. These may happen as bug reports, feature requests, or code contributions. For details, please check our contribution guidelines.

Show & Tell: Share Your Inspiration

We encourage you to utilize our Show & Tell area in the Discussions section of this repository. This space is designed for you to:

  • Share the tutorials you've created
  • Showcase your learning content
  • Present exciting projects you've developed

By sharing your work, you'll inspire others and contribute to the collective knowledge of our community. Your contributions can spark new ideas and collaborations, fostering innovation in robotics and simulation.

Troubleshooting

Please see the troubleshooting section for common fixes or submit an issue.

For issues related to Isaac Sim, we recommend checking its documentation or opening a question on its forums.

Support

  • Please use GitHub Discussions for discussing ideas, asking questions, and requests for new features.
  • Github Issues should only be used to track executable pieces of work with a definite scope and a clear deliverable. These can be fixing bugs, documentation issues, new features, or general updates.

Connect with the NVIDIA Omniverse Community

Do you have a project or resource you'd like to share more widely? We'd love to hear from you! Reach out to the NVIDIA Omniverse Community team at OmniverseCommunity@nvidia.com to explore opportunities to spotlight your work.

You can also join the conversation on the Omniverse Discord to connect with other developers, share your projects, and help grow a vibrant, collaborative ecosystem where creativity and technology intersect. Your contributions can make a meaningful impact on the Isaac Lab community and beyond!

License

The Isaac Lab framework is released under BSD-3 License. The isaaclab_mimic extension and its corresponding standalone scripts are released under Apache 2.0. The license files of its dependencies and assets are present in the docs/licenses directory.

Acknowledgement

Isaac Lab development initiated from the Orbit framework. We would appreciate if you would cite it in academic publications as well:

@article{mittal2023orbit, author={Mittal, Mayank and Yu, Calvin and Yu, Qinxi and Liu, Jingzhou and Rudin, Nikita and Hoeller, David and Yuan, Jia Lin and Singh, Ritvik and Guo, Yunrong and Mazhar, Hammad and Mandlekar, Ajay and Babich, Buck and State, Gavriel and Hutter, Marco and Garg, Animesh}, journal={IEEE Robotics and Automation Letters}, title={Orbit: A Unified Simulation Framework for Interactive Robot Learning Environments}, year={2023}, volume={8}, number={6}, pages={3740-3747}, doi={10.1109/LRA.2023.3270034} }

Owner

  • Name: IsaacSim
  • Login: isaac-sim
  • Kind: organization

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 976
  • Total Committers: 122
  • Avg Commits per committer: 8.0
  • Development Distribution Score (DDS): 0.689
Past Year
  • Commits: 613
  • Committers: 103
  • Avg Commits per committer: 5.951
  • Development Distribution Score (DDS): 0.783
Top Committers
Name Email Commits
Mayank Mittal 1****6 304
Kelly Guo k****g@n****m 133
David Hoeller d****r@n****m 50
Pascal Roth 5****h 48
Toni-SM a****o@n****m 31
AutonomousHansen 5****n 29
peterd-NV p****d@n****m 29
James Smith 1****i 29
James Tigue 1****i 17
Hunter Hansen 5****i 16
rwiltz 1****z 15
Michael Gussert m****l@g****m 12
robotsfan f****4@g****m 11
cosmith-nvidia 1****a 10
CY Chen c****c@n****m 9
renezurbruegg r****g@g****m 8
chengronglai c****l@n****m 8
Ashwin Varghese Kuruttukulam 1****V 8
David Hoeller d****r@e****h 8
Farbod Farshidian f****n@t****m 7
lgulich 2****h 7
matthewtrepte m****e@n****m 7
glvov-bdai g****v@t****m 6
Octi Zhang 1****s 6
Nikita Rudin 4****n 6
Alexander Poddubny 1****y 6
Masoud Moghani m****i@c****u 6
Özhan Özen 4****n 6
jaczhangnv j****g@n****m 5
oahmednv o****d@N****m 5
and 92 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1,340
  • Total pull requests: 1,158
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 14 days
  • Total issue authors: 695
  • Total pull request authors: 198
  • Average comments per issue: 1.36
  • Average comments per pull request: 0.92
  • Merged pull requests: 630
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1,051
  • Pull requests: 977
  • Average time to close issues: 18 days
  • Average time to close pull requests: 10 days
  • Issue authors: 574
  • Pull request authors: 167
  • Average comments per issue: 1.33
  • Average comments per pull request: 0.79
  • Merged pull requests: 528
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • H-Hisamichi (27)
  • jsmith-bdai (19)
  • Entongsu (18)
  • zoctipus (16)
  • hojae-io (15)
  • ozhanozen (14)
  • Mayankm96 (14)
  • shiven2001 (11)
  • celestialdr4g0n (9)
  • KevinGeng3 (8)
  • supersglzc (8)
  • shaoxiang (8)
  • KyleM73 (7)
  • dhruvkm2402 (7)
  • ori-gadot (7)
Pull Request Authors
  • Mayankm96 (157)
  • kellyguo11 (155)
  • jtigue-bdai (77)
  • pascal-roth (66)
  • fan-ziqi (37)
  • Dhoeller19 (37)
  • louislelay (26)
  • ooctipus (26)
  • mpgussert (23)
  • Toni-SM (20)
  • jsmith-bdai (18)
  • lgulich (17)
  • AntoineRichard (17)
  • ozhanozen (13)
  • glvov-bdai (13)
Top Labels
Issue Labels
question (98) bug (98) enhancement (43) documentation (23) isaac-sim (13) dev team (10) duplicate (6) invalid (4) asset (2) imitation learning (1) good first issue (1) help wanted (1) wontfix (1) verify (1)
Pull Request Labels
enhancement (110) bug (104) documentation (62) dev team (33) asset (3) duplicate (1) question (1)

Dependencies

.github/workflows/docs.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/pre-commit.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pre-commit/action v3.0.0 composite
docs/requirements.txt pypi
  • Jinja2 ==3.0.3
  • Sphinx ==4.5.0
  • autodocsumm ==0.2.9
  • matplotlib *
  • myst-parser ==0.18.1
  • numpy *
  • sphinx-book-theme ==0.3.3
  • sphinx-copybutton *
  • sphinxcontrib-bibtex ==2.5.0
  • warp-lang *
pyproject.toml pypi
source/extensions/omni.isaac.contrib_envs/setup.py pypi
source/extensions/omni.isaac.orbit/setup.py pypi
source/extensions/omni.isaac.orbit_envs/setup.py pypi