Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifies Isaac Lab ecosystem and installation steps in documentation #1338

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

kellyguo11
Copy link
Contributor

Description

This change adds a new page highlighting the Isaac Lab ecosystem and relationship with Omniverse and Isaac Sim. It also clarifies the installation steps with recommendations on when each installation approach should be used.

Type of change

  • This change requires a documentation update

Checklist

  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

Isaac Lab Ecosystem
===================

Isaac Lab is built on top of Isaac Sim to provide a unified and flexible framework
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about the discussion here?

https://isaac-sim.github.io/IsaacLab/main/source/setup/faq.html

Seems some duplication?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied over a bit of the content from FAQ and linked to the page at the bottom. The ask was to make it easier for people to find the information and present it in a more condensed and easier to understand way.

of new features that pertain to robot learning research. For example, including actuator dynamics in the
simulation, procedural terrain generation, and support to collect data from human demonstrations.

.. figure:: ../_static/setup/ecosystem.jpg
Copy link
Contributor

@Mayankm96 Mayankm96 Oct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need an image for the dark theme as well?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also would be nice to arrange the blocks in the figure to make it coherent. Right now it appears like a jumble of different things (RL on one corner and IL on the other). IMO we should have them one under the other. Basically it should be easier to understand if things that are "similar" are next to each other


.. code-block:: bash

pip install isaacsim-rl isaacsim-replicator isaacsim-extscache-physics isaacsim-extscache-kit-sdk isaacsim-extscache-kit isaacsim-app --extra-index-url https://pypi.nvidia.com
pip install isaacsim==4.2.0.2 --extra-index-url https://pypi.nvidia.com
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this get you everything from isaac-sim or the bare minimum we need?

@Mayankm96 Mayankm96 added the documentation Improvements or additions to documentation label Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants