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

Reorganizes the structure to drop omni.isaac and directly use isaaclab as extension name #590

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

pascal-roth
Copy link
Collaborator

@pascal-roth pascal-roth commented Jun 28, 2024

Description

Reorganize the extensions to achieve a simpler and easier-to-understand structure. We make use of Kit 106, which drops the requirement to have the extension name as a composition of at least two elements separated by a dot and instead allows for a single word as name. Consequently, the extensions are renamed as follows:

  • omni.isaac.lab --> isaaclab
  • omni.isaac.lab_tasks --> isaaclab_tasks
  • omni.isaac.lab_assets --> isaaclab_assets

This reduces the structure from omni.isaac.lab/omni/isaac/lab to isaaclab/isaaclab.

Type of change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Screenshots

While extensions can still be found as expected

Screenshot from 2024-06-24 18-15-43

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 run all the tests with ./isaaclab.sh --test and they pass
  • 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

@pascal-roth pascal-roth self-assigned this Jun 28, 2024
@Mayankm96
Copy link
Contributor

Does this also work with Isaac Sim 2023.1.1? Just wondering if Kit 105.1 already supported a single extension name. Otherwise, this change also means a drop in support for 2023.1.1.

@pascal-roth
Copy link
Collaborator Author

@Mayankm96 I can test it but are we backward compatible in general so far with the code changes?

@pascal-roth
Copy link
Collaborator Author

also after merging #617 and #616 (introducing a Velodyne lidar and zed depth cameras), a further split of the assets into robots and sensors necessary

@Mayankm96
Copy link
Contributor

@pascal-roth We discussed this internally, and Isaac Sim will change its extension naming following a style similar to the above in November. We have received push-back to do this change as it will break the user's experience twice (once now and again in November when Isaac Sim breaks the APIs). Hence, we have also decided to do this in November with Isaac Sim.

@Mayankm96 Mayankm96 closed this Jul 9, 2024
@Mayankm96 Mayankm96 deleted the fix/simplify-ext-strucure branch July 9, 2024 08:32
@pascal-roth pascal-roth restored the fix/simplify-ext-strucure branch August 15, 2024 12:39
@pascal-roth pascal-roth reopened this Aug 28, 2024
@pascal-roth pascal-roth marked this pull request as draft August 28, 2024 11:05
@pascal-roth
Copy link
Collaborator Author

There is no need for a review now; will be addressed in November when IsaacSim will also be renamed. Keep the PR open as information.

@pascal-roth pascal-roth added the enhancement New feature or request label Aug 28, 2024
@pascal-roth pascal-roth added the dev team Issue or pull request created by the dev team label Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev team Issue or pull request created by the dev team enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants