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.

Sign up for GitHub

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

Jump to bottom

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
+2,211 −2,332
Draft

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f5a5c7f
initial renaming (direct move deletes and recreates all files)
pascal-roth Jun 24, 2024
39d69c4
rename core
pascal-roth Jun 28, 2024
257edc4
move tasks
pascal-roth Jun 28, 2024
18ab3b4
move assets
pascal-roth Jun 28, 2024
59e8d4d
move new test
pascal-roth Jun 28, 2024
dbb97f2
run formatter
pascal-roth Jun 28, 2024
25491ea
Merge branch 'main' into fix/simplify-ext-strucure
pascal-roth Jun 28, 2024
2ece542
adjust changelog
pascal-roth Jun 28, 2024
cbd16e0
remove prev deleted doc
pascal-roth Jun 28, 2024
80d4c5d
readd test
pascal-roth Jun 28, 2024
0da3a77
remove wrongfullt added file
pascal-roth Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ repos:
- id: pyupgrade
args: ["--py310-plus"]
# FIXME: This is a hack because Pytorch does not like: torch.Tensor | dict aliasing
exclude: "source/extensions/omni.isaac.lab/omni/isaac/lab/envs/common.py"
exclude: "source/extensions/isaaclab/isaaclab/envs/common.py"
- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
hooks:
Expand Down
8 changes: 4 additions & 4 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@
import os
import sys

sys.path.insert(0, os.path.abspath("../source/extensions/omni.isaac.lab"))
sys.path.insert(0, os.path.abspath("../source/extensions/omni.isaac.lab/omni/isaac/lab"))
sys.path.insert(0, os.path.abspath("../source/extensions/omni.isaac.lab_tasks"))
sys.path.insert(0, os.path.abspath("../source/extensions/omni.isaac.lab_tasks/omni/isaac/lab_tasks"))
sys.path.insert(0, os.path.abspath("../source/extensions/isaaclab"))
sys.path.insert(0, os.path.abspath("../source/extensions/isaaclab/isaaclab"))
sys.path.insert(0, os.path.abspath("../source/extensions/isaaclab_tasks"))
sys.path.insert(0, os.path.abspath("../source/extensions/isaaclab_tasks/isaaclab_tasks"))

# -- Project information -----------------------------------------------------

Expand Down
28 changes: 14 additions & 14 deletions docs/source/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ API Reference

This page gives an overview of all the modules and classes in the Isaac Lab extensions.

omni.isaac.lab extension
isaaclab extension
------------------------

The following modules are available in the ``omni.isaac.lab`` extension:
The following modules are available in the ``isaaclab`` extension:

.. currentmodule:: omni.isaac.lab
.. currentmodule:: isaaclab

.. autosummary::
:toctree: lab
Expand All @@ -30,19 +30,19 @@ The following modules are available in the ``omni.isaac.lab`` extension:
.. toctree::
:hidden:

lab/omni.isaac.lab.envs.mdp
lab/omni.isaac.lab.envs.ui
lab/omni.isaac.lab.sensors.patterns
lab/omni.isaac.lab.sim.converters
lab/omni.isaac.lab.sim.schemas
lab/omni.isaac.lab.sim.spawners
lab/isaaclab.envs.mdp
lab/isaaclab.envs.ui
lab/isaaclab.sensors.patterns
lab/isaaclab.sim.converters
lab/isaaclab.sim.schemas
lab/isaaclab.sim.spawners

omni.isaac.lab_tasks extension
isaaclab_tasks extension
--------------------------------

The following modules are available in the ``omni.isaac.lab_tasks`` extension:
The following modules are available in the ``isaaclab_tasks`` extension:

.. currentmodule:: omni.isaac.lab_tasks
.. currentmodule:: isaaclab_tasks

.. autosummary::
:toctree: lab_tasks
Expand All @@ -53,5 +53,5 @@ The following modules are available in the ``omni.isaac.lab_tasks`` extension:
.. toctree::
:hidden:

lab_tasks/omni.isaac.lab_tasks.utils.wrappers
lab_tasks/omni.isaac.lab_tasks.utils.data_collector
lab_tasks/isaaclab_tasks.utils.wrappers
lab_tasks/isaaclab_tasks.utils.data_collector
4 changes: 2 additions & 2 deletions docs/source/api/lab/omni.isaac.lab.actuators.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.actuators
isaaclab.actuators
========================

.. automodule:: omni.isaac.lab.actuators
.. automodule:: isaaclab.actuators

.. rubric:: Classes

Expand Down
8 changes: 4 additions & 4 deletions docs/source/api/lab/omni.isaac.lab.app.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.app
isaaclab.app
==================

.. automodule:: omni.isaac.lab.app
.. automodule:: isaaclab.app

.. rubric:: Classes

Expand Down Expand Up @@ -44,7 +44,7 @@ The following details the behavior of the class based on the environment variabl
.. note::

The off-screen rendering pipeline only works when used in conjunction with the
:class:`omni.isaac.lab.sim.SimulationContext` class. This is because the off-screen rendering
:class:`isaaclab.sim.SimulationContext` class. This is because the off-screen rendering
pipeline enables flags that are internally used by the SimulationContext class.


Expand Down Expand Up @@ -77,7 +77,7 @@ The following snippet shows how use the :class:`AppLauncher` in different ways:

import argparser

from omni.isaac.lab.app import AppLauncher
from isaaclab.app import AppLauncher

# add argparse arguments
parser = argparse.ArgumentParser()
Expand Down
6 changes: 3 additions & 3 deletions docs/source/api/lab/omni.isaac.lab.assets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.assets
isaaclab.assets
=====================

.. automodule:: omni.isaac.lab.assets
.. automodule:: isaaclab.assets

.. rubric:: Classes

Expand All @@ -16,7 +16,7 @@
ArticulationData
ArticulationCfg

.. currentmodule:: omni.isaac.lab.assets
.. currentmodule:: isaaclab.assets

Asset Base
----------
Expand Down
4 changes: 2 additions & 2 deletions docs/source/api/lab/omni.isaac.lab.controllers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.controllers
isaaclab.controllers
==========================

.. automodule:: omni.isaac.lab.controllers
.. automodule:: isaaclab.controllers

.. rubric:: Classes

Expand Down
4 changes: 2 additions & 2 deletions docs/source/api/lab/omni.isaac.lab.devices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.devices
isaaclab.devices
======================

.. automodule:: omni.isaac.lab.devices
.. automodule:: isaaclab.devices

.. rubric:: Classes

Expand Down
22 changes: 11 additions & 11 deletions docs/source/api/lab/omni.isaac.lab.envs.mdp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,54 +1,54 @@
omni.isaac.lab.envs.mdp
isaaclab.envs.mdp
=======================

.. automodule:: omni.isaac.lab.envs.mdp
.. automodule:: isaaclab.envs.mdp

Observations
------------

.. automodule:: omni.isaac.lab.envs.mdp.observations
.. automodule:: isaaclab.envs.mdp.observations
:members:

Actions
-------

.. automodule:: omni.isaac.lab.envs.mdp.actions
.. automodule:: isaaclab.envs.mdp.actions

.. automodule:: omni.isaac.lab.envs.mdp.actions.actions_cfg
.. automodule:: isaaclab.envs.mdp.actions.actions_cfg
:members:
:show-inheritance:
:exclude-members: __init__, class_type

Events
------

.. automodule:: omni.isaac.lab.envs.mdp.events
.. automodule:: isaaclab.envs.mdp.events
:members:

Commands
--------

.. automodule:: omni.isaac.lab.envs.mdp.commands
.. automodule:: isaaclab.envs.mdp.commands

.. automodule:: omni.isaac.lab.envs.mdp.commands.commands_cfg
.. automodule:: isaaclab.envs.mdp.commands.commands_cfg
:members:
:show-inheritance:
:exclude-members: __init__, class_type

Rewards
-------

.. automodule:: omni.isaac.lab.envs.mdp.rewards
.. automodule:: isaaclab.envs.mdp.rewards
:members:

Terminations
------------

.. automodule:: omni.isaac.lab.envs.mdp.terminations
.. automodule:: isaaclab.envs.mdp.terminations
:members:

Curriculum
----------

.. automodule:: omni.isaac.lab.envs.mdp.curriculums
.. automodule:: isaaclab.envs.mdp.curriculums
:members:
4 changes: 2 additions & 2 deletions docs/source/api/lab/omni.isaac.lab.envs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.envs
isaaclab.envs
===================

.. automodule:: omni.isaac.lab.envs
.. automodule:: isaaclab.envs

.. rubric:: Submodules

Expand Down
4 changes: 2 additions & 2 deletions docs/source/api/lab/omni.isaac.lab.envs.ui.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.envs.ui
isaaclab.envs.ui
======================

.. automodule:: omni.isaac.lab.envs.ui
.. automodule:: isaaclab.envs.ui

.. rubric:: Classes

Expand Down
4 changes: 2 additions & 2 deletions docs/source/api/lab/omni.isaac.lab.managers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.managers
isaaclab.managers
=======================

.. automodule:: omni.isaac.lab.managers
.. automodule:: isaaclab.managers

.. rubric:: Classes

Expand Down
4 changes: 2 additions & 2 deletions docs/source/api/lab/omni.isaac.lab.markers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.markers
isaaclab.markers
======================

.. automodule:: omni.isaac.lab.markers
.. automodule:: isaaclab.markers

.. rubric:: Classes

Expand Down
4 changes: 2 additions & 2 deletions docs/source/api/lab/omni.isaac.lab.scene.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.scene
isaaclab.scene
====================

.. automodule:: omni.isaac.lab.scene
.. automodule:: isaaclab.scene

.. rubric:: Classes

Expand Down
10 changes: 5 additions & 5 deletions docs/source/api/lab/omni.isaac.lab.sensors.patterns.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.sensors.patterns
isaaclab.sensors.patterns
===============================

.. automodule:: omni.isaac.lab.sensors.patterns
.. automodule:: isaaclab.sensors.patterns

.. rubric:: Classes

Expand All @@ -23,7 +23,7 @@ Pattern Base
Grid Pattern
------------

.. autofunction:: omni.isaac.lab.sensors.patterns.grid_pattern
.. autofunction:: isaaclab.sensors.patterns.grid_pattern

.. autoclass:: GridPatternCfg
:members:
Expand All @@ -33,7 +33,7 @@ Grid Pattern
Pinhole Camera Pattern
----------------------

.. autofunction:: omni.isaac.lab.sensors.patterns.pinhole_camera_pattern
.. autofunction:: isaaclab.sensors.patterns.pinhole_camera_pattern

.. autoclass:: PinholeCameraPatternCfg
:members:
Expand All @@ -43,7 +43,7 @@ Pinhole Camera Pattern
RS-Bpearl Pattern
-----------------

.. autofunction:: omni.isaac.lab.sensors.patterns.bpearl_pattern
.. autofunction:: isaaclab.sensors.patterns.bpearl_pattern

.. autoclass:: BpearlPatternCfg
:members:
Expand Down
4 changes: 2 additions & 2 deletions docs/source/api/lab/omni.isaac.lab.sensors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.sensors
isaaclab.sensors
======================

.. automodule:: omni.isaac.lab.sensors
.. automodule:: isaaclab.sensors

.. rubric:: Submodules

Expand Down
4 changes: 2 additions & 2 deletions docs/source/api/lab/omni.isaac.lab.sim.converters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.sim.converters
isaaclab.sim.converters
=============================

.. automodule:: omni.isaac.lab.sim.converters
.. automodule:: isaaclab.sim.converters

.. rubric:: Classes

Expand Down
6 changes: 3 additions & 3 deletions docs/source/api/lab/omni.isaac.lab.sim.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.sim
isaaclab.sim
==================

.. automodule:: omni.isaac.lab.sim
.. automodule:: isaaclab.sim

.. rubric:: Submodules

Expand Down Expand Up @@ -54,6 +54,6 @@ Simulation Context Builder
Utilities
---------

.. automodule:: omni.isaac.lab.sim.utils
.. automodule:: isaaclab.sim.utils
:members:
:show-inheritance:
4 changes: 2 additions & 2 deletions docs/source/api/lab/omni.isaac.lab.sim.schemas.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
omni.isaac.lab.sim.schemas
isaaclab.sim.schemas
==========================

.. automodule:: omni.isaac.lab.sim.schemas
.. automodule:: isaaclab.sim.schemas

.. rubric:: Classes

Expand Down