Adds new external project / internal task template generator #2039

Toni-SM · 2025-03-07T17:38:14Z

Description

This PR adds the implementation to generate Isaac Lab's external project or internal task.

Just run ./isaaclab.sh --new or isaaclab.bat --new (or -n) and let yourself go!

Type of change

New feature (non-breaking change which adds functionality)
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

template/templates/external/.vscode/tools/launch.template.json

template/templates/external/.vscode/tasks.json

Mayankm96

Amazing work! Thank you for pulling this together!

Quick feedback:

Can we move the template directory to tools to have all these utilities together?
Need to also modify instructions here: https://isaac-sim.github.io/IsaacLab/main/source/overview/developer-guide/template.html
If we modify something in core, we need to modify the env and env_cfg inside the tasks directory in the template?

Toni-SM · 2025-03-07T23:11:46Z

Quick feedback:

Can we move the template directory to tools to have all these utilities together?

Need to also modify instructions here: https://isaac-sim.github.io/IsaacLab/main/source/overview/developer-guide/template.html

If we modify something in core, we need to modify the env and env_cfg inside the tasks directory in the template?

Done
Done
Yes, it is. We could copy (and replace with the new names) the tasks directly from the Isaac Lab code (in this case for the Cartpole/Cart-Double-Pendulum). However, I have chosen to separate the task files in order to add (in the near future), comments and links to help users to re-do the task according to their needs. Such comments and links would clutter the current task files in isaaclab_tasks if we were to add them there.

docs/source/overview/developer-guide/template.rst

tools/template/templates/external/.vscode/tasks.json

tools/template/templates/external/.vscode/tools/launch.template.json

kellyguo11 · 2025-03-09T05:38:27Z

tools/template/templates/external/README.md

+
+### Building Isaac Lab Base Image
+
+Currently, we don't have the Docker for Isaac Lab publicly available. Hence, you'd need to build the docker image


we do have the prebuilt Isaac Lab docker now

Inherited from https://github.com/isaac-sim/IsaacLabExtensionTemplate.
Should we remove those steps?

kellyguo11 · 2025-03-09T05:39:16Z

tools/template/templates/external/README.md

+
+### Building Isaac Lab Template Image
+
+Following above, you can build the docker container for this project. It is called `isaac-lab-template`. However,


do these docker steps still apply for the new template that's generated?

Inherited from https://github.com/isaac-sim/IsaacLabExtensionTemplate.
Should we remove those steps?

would still be good to support docker. do you mind verifying the steps to see we can still follow them to use the new template in docker?

tools/template/templates/tasks/__init__task

Co-authored-by: Kelly Guo <kellyg@nvidia.com> Signed-off-by: Toni-SM <toni.semu@gmail.com>

Signed-off-by: Kelly Guo <kellyguo123@hotmail.com>

tools/template/templates/extension/setup.py

Signed-off-by: Kelly Guo <kellyguo123@hotmail.com>

# Description This PR adds the implementation to generate Isaac Lab's external project or internal task. Just run `./isaaclab.sh --new` or `isaaclab.bat --new` (or `-n`) and let yourself go! ## Type of change - New feature (non-breaking change which adds functionality) - This change requires a documentation update ## Checklist - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [ ] I have made corresponding changes to the documentation - [x] 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 - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there  --------- Signed-off-by: Toni-SM <toni.semu@gmail.com> Signed-off-by: Kelly Guo <kellyguo123@hotmail.com> Co-authored-by: Kelly Guo <kellyg@nvidia.com>

…im#2039) # Description This PR adds the implementation to generate Isaac Lab's external project or internal task. Just run `./isaaclab.sh --new` or `isaaclab.bat --new` (or `-n`) and let yourself go! ## Type of change - New feature (non-breaking change which adds functionality) - This change requires a documentation update ## Checklist - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [ ] I have made corresponding changes to the documentation - [x] 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 - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there  --------- Signed-off-by: Toni-SM <toni.semu@gmail.com> Signed-off-by: Kelly Guo <kellyguo123@hotmail.com> Co-authored-by: Kelly Guo <kellyg@nvidia.com>

Toni-SM added 25 commits March 4, 2025 12:32

Add initial template generator implementation

0742b35

Remove/rename files

59835b6

Initial implementation for external projects

31d3139

Merge branch 'main' into feature/template_generator

1eca912

Update CLI implementation

0449642

Add placeholder for extension template to reinforcement learning scripts

dfc4490

Add template generation entry to isaaclab main scripts

a3a1fb7

Merge branch 'main' into feature/template_generator

86d4240

Generate some external project files

af565a7

Add docker folder

577c9ac

Add .vscode folder

4acdf90

Copy extension setup.py file

f6c1e17

Validate specification and use different name according to project type

4c76132

Remplace placeholder in scripts

f11c663

Add missing files in scripts and source folder in external project

ace9b8e

Add extension files to make tasks discoverable

1f32a00

List template tasks

f0e77b0

Add external project README

4d2af8b

Copy external project __init__.py files

dd012d8

Apply pre-commit hooks

adfd4d2

Add missing docstrings

2d62765

Setup git repo in external project and print generation info

c0f4938

Install template dependencies

fcb4371

Merge branch 'main' into feature/template_generator

2e0ea75

Add extension UI example

25a774f

Toni-SM requested review from Mayankm96, hhansen-bdai, jsmith-bdai and kellyguo11 as code owners March 7, 2025 17:38

Add missing installation steps to isaaclab.bat

882277b

Mayankm96 reviewed Mar 7, 2025

View reviewed changes

template/templates/external/.vscode/tools/launch.template.json Outdated Show resolved Hide resolved

Mayankm96 reviewed Mar 7, 2025

View reviewed changes

template/templates/external/.vscode/tasks.json Outdated Show resolved Hide resolved

Mayankm96 requested changes Mar 7, 2025

View reviewed changes

Toni-SM added 5 commits March 7, 2025 16:17

Move template folder inside tools

c48342d

Update isaaclab script

386d605

Rename template files

b0034d8

Update root path

2a55b90

Update docs

9f33622

Add note about Git to external project documentation

6990a71

kellyguo11 reviewed Mar 9, 2025

View reviewed changes

Toni-SM and others added 8 commits March 10, 2025 10:11

Merge branch 'main' into feature/template_generator

d5e84c7

Update docs/source/overview/developer-guide/template.rst

6efef9f

Co-authored-by: Kelly Guo <kellyg@nvidia.com> Signed-off-by: Toni-SM <toni.semu@gmail.com>

Update docs/source/overview/developer-guide/template.rst

99f53e5

Co-authored-by: Kelly Guo <kellyg@nvidia.com> Signed-off-by: Toni-SM <toni.semu@gmail.com>

Update docs/source/overview/developer-guide/template.rst

39e0393

Co-authored-by: Kelly Guo <kellyg@nvidia.com> Signed-off-by: Toni-SM <toni.semu@gmail.com>

Update docs/source/overview/developer-guide/template.rst

27a76c3

Co-authored-by: Kelly Guo <kellyg@nvidia.com> Signed-off-by: Toni-SM <toni.semu@gmail.com>

Update docs

203262d

Update default Isaac Sim path in .vscode config

fd32ba6

Generate vscode launch entries

808c6f2

kellyguo11 changed the title ~~Isaac Lab's external project / internal task template generator~~ Adds new external project / internal task template generator Mar 11, 2025

Toni-SM and others added 4 commits March 11, 2025 11:07

Merge branch 'main' into feature/template_generator

e6153ff

Add LICENSE to template files

e3d1807

Remove docker steps from documentation

d533486

Update tools/template/templates/extension/setup.py

5c3c39c

Signed-off-by: Kelly Guo <kellyguo123@hotmail.com>

kellyguo11 reviewed Mar 13, 2025

View reviewed changes

tools/template/templates/extension/setup.py Outdated Show resolved Hide resolved

Update tools/template/templates/extension/setup.py

816b5a2

Signed-off-by: Kelly Guo <kellyguo123@hotmail.com>

kellyguo11 merged commit 80e3964 into main Mar 13, 2025
4 of 5 checks passed

kellyguo11 deleted the feature/template_generator branch March 13, 2025 03:47


		### Building Isaac Lab Base Image

		Currently, we don't have the Docker for Isaac Lab publicly available. Hence, you'd need to build the docker image


		### Building Isaac Lab Template Image

		Following above, you can build the docker container for this project. It is called `isaac-lab-template`. However,

Adds new external project / internal task template generator #2039

Adds new external project / internal task template generator #2039

Uh oh!

Conversation

Toni-SM commented Mar 7, 2025

Description

Type of change

Checklist

Uh oh!

Uh oh!

Uh oh!

Mayankm96 left a comment

Choose a reason for hiding this comment

Uh oh!

Toni-SM commented Mar 7, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kellyguo11 Mar 9, 2025

Choose a reason for hiding this comment

Uh oh!

Toni-SM Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

kellyguo11 Mar 9, 2025

Choose a reason for hiding this comment

Uh oh!

Toni-SM Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

kellyguo11 Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants