# Description

<!--
Thank you for your interest in sending a pull request. Please make sure
to check the contribution guidelines.

Link: https://isaac-orbit.github.io/orbit/source/refs/contributing.html
-->

As a step towards supporting sensors as "Views", this PR upgrades the
`SensorBase` class to follow a similar definition as `RobotBase` and
updates the sensor implementations as well. Now, the following sensors
are supported:

* `Camera`: This spawns a USD camera object and instantiates it with
replicator OmniGraph for different synthetic data
* `RayCaster`: This is a virtual sensor that uses a warp kernel for
raycasting against static meshes.
* `ContactSensor`: This wraps around the `RigidContactView` from PhysX
to provide the contact forces on encapsulated prims.

Note: Currently camera rendering is not truly parallelized. They are
called sequentially inside the `Camera` to fetch their data.
Additionally, some camera data such as bounding boxes are not possible
to get in the torch backend. Due to this, they are not supported in the
new `Camera` class.

Old the old sensor implementations have been moved to the
`omni.isaac.orbit.compat.sensors` module for backwards compatibility. We
will remove them once we have moved to v1.0.

Fixes #3

<!-- As a practice, it is recommended to open an issue to have
discussions on the proposed pull request.
This makes it easier for the community to keep track of what is being
developed or added, and if a given feature
is demanded by more than one party. -->

## Type of change

<!-- As you go through the list, delete the ones that are not
applicable. -->

- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- This change requires a documentation update

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./orbit.sh --format`
- [x] 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
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->

# Description

Adds a directory `docker` in the root of the repo, containing a
`Dockerfile`, `dockerfile-compose.yaml`, `.env`, and utility script
`container.sh` that wraps docker-compose CLI commands. The instructions
in the documentation specify the installation steps and how to get the
Isaac Sim docker image for completeness.

To run a container, the user needs to create NGC credentials via the
NVIDIA Developers program. After that they can run the script to launch
the container:

```bash
./docker/container.sh start
./docker/container.sh enter
```

Also added an argument `-o` or `--docker` to the `orbit.sh` that calls
the above script. The above then becomes:

```bash
./orbit.sh -o start 
./orbit.sh -o enter
```

Fixes #23 

## Type of change

- New feature (non-breaking change which adds functionality)

## Checklist

- [X] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./orbit.sh --format`
- [X] 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

---------
Co-authored-by: Mayank Mittal <mittalma@leggedrobotics.com>

# Description

<!--
Thank you for your interest in sending a pull request. Please make sure
to check the contribution guidelines.

Link: https://isaac-orbit.github.io/orbit/source/refs/contributing.html
-->

Previously the `make_plane` function was always offsetting the terrain
origin such that the origin of the plane coincides with (0, 0). This was
done because when adding a ground plane, we wanted the origin to match
the simulation origin. However, it introduced a bug in sub-terrain
generator where we assume that all sub-terrains are origin at (size_x *
0.5, size_y * 0.5).

The PR fixes this issue by making an explicit argument to `make_plane`
called `centered`. Also adds comments to make it clear what the
sub-terrain generator and terrain importer does.

<!-- As a practice, it is recommended to open an issue to have
discussions on the proposed pull request.
This makes it easier for the community to keep track of what is being
developed or added, and if a given feature
is demanded by more than one party. -->

## Type of change

<!-- As you go through the list, delete the ones that are not
applicable. -->

- Bug fix (non-breaking change which fixes an issue)

## Screenshots

| Before | After |
| ------ | ----- |
|
![bug](https://github.com/isaac-orbit/orbit/assets/12863862/1ce9db23-b97b-44d9-8a4e-1c543eab914b)|
![fix](https://github.com/isaac-orbit/orbit/assets/12863862/b347077b-daa6-4d76-a307-4e97450ccce9)
|


## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./orbit.sh --format`
- [x] 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
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->

# Description

<!--
Thank you for your interest in sending a pull request. Please make sure
to check the contribution guidelines.

Link: https://isaac-orbit.github.io/orbit/source/refs/contributing.html
-->

Previously, we were having separate markers for frames, spheres, and
height scanners, each of them having minute differences. This PR
includes a more general wrapping around the
[`USDGeom.PointInstancer`](https://graphics.pixar.com/usd/dev/api/class_usd_geom_point_instancer.html)
to configure markers through configclass object. Additionally, it moves
to faster
[`pxr.Vt`](https://docs.omniverse.nvidia.com/kit/docs/kit-manual/latest/api/pxr.html#module-pxr.Vt)
arrays instead of keeping a list of
[`pxr.Gf`](https://docs.omniverse.nvidia.com/kit/docs/kit-manual/latest/api/pxr.html#module-pxr.Gf)
arrays.

The old markers still exist for now until we move to v1.0 release. They
are present in the `omni.isaac.orbit.compat` module.

<!-- As a practice, it is recommended to open an issue to have
discussions on the proposed pull request.
This makes it easier for the community to keep track of what is being
developed or added, and if a given feature
is demanded by more than one party. -->

## Type of change

<!-- As you go through the list, delete the ones that are not
applicable. -->

- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- This change requires a documentation update

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./orbit.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->

# Description

<!--
Thank you for your interest in sending a pull request. Please make sure
to check the contribution guidelines.

Link: https://isaac-orbit.github.io/orbit/source/refs/contributing.html
-->

This PR ports in the functions for procedurally generating different
terrains. The terrains can be generated as heightfields (2.5 D elevation
map) or meshes (through `trimesh`).

There are two separate classes:
* `TerrainGenerator`: This class only procedurally generates terrains
based on the passed sub-terrain configuration. It creates the trimesh
object and contains the origins of each terrain in the mesh.
Additionally, it performs caching of the sub-terrain meshes based on
their configuration. By default, caching is disabled since most
developers will change not only the config, but also the function.
* `TerrainImporter`: This class mainly deals with importing terrains
from different possible sources and adding them to the simulator. In
addition to importing terrains, it also stores them into a dictionary
called `warp_meshes` that later can be used for ray-casting. The types
of terrain sources are as follows:
* `import_ground_plane`: creates a grid plane which is default in
isaacsim/orbit.
    * `import_mesh`: takes a trimesh object
    * `import_usd`: takes a USD file and adds reference to it

<!-- As a practice, it is recommended to open an issue to have
discussions on the proposed pull request.
This makes it easier for the community to keep track of what is being
developed or added, and if a given feature
is demanded by more than one party. -->

## Type of change

<!-- As you go through the list, delete the ones that are not
applicable. -->

- New feature (non-breaking change which adds functionality)

## Screenshots


![terrains](https://github.com/isaac-orbit/orbit/assets/12863862/05f889d0-b98e-4063-a810-89d9116c2dfe)

<!--
Example:

| Before | After |
| ------ | ----- |
| _gif/png before_ | _gif/png after_ |

To upload images to a PR -- simply drag and drop an image while in edit
mode and it should upload the image directly. You can then paste that
source into the above before/after sections.
-->

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./orbit.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->

# Description

Adds the class `AppLauncher` which takes configuration arguments to the
Isaac Sim `SimulationApp` and several environment variables. It launches
the SimulationApp and corresponding extensions in a controlled manner
allowing users to decide between different remote deployments, ROS
bridges, and viewport rendering.

AppLauncher can then be queried for logic on other SimulationApp
operations e.g. whether or not `SimulationContext.step()` should render
or not based on the resolved flags `AppLauncher.VIEWPORT` and
`AppLauncher.RENDER`.

Fixes #32 

## 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
`./orbit.sh --format`
- [x] 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
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file

---------
Co-authored-by: Farbod Farshidian <ffarshidian@theaiinstitute.com>
Co-authored-by: Mayank Mittal <mittalma@leggedrobotics.com>

# Description

Adds a helper class that converts a urdf description into an
instanceable usd file with separate meshes.

If a `usd_dir` is provided, the conversion is lazy: It only performs
conversion if the provided `UrdfLoaderCfg` or the main URDF file is
modified. The current implementation does not automatically trigger USD
generation if only mesh files are changed.

Fixes #35 

## 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
`./orbit.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file

---------
Co-authored-by: Mayank Mittal <mittalma@leggedrobotics.com>

# Description

<!--
Thank you for your interest in sending a pull request. Please make sure to check the contribution guidelines.

Link: https://isaac-orbit.github.io/orbit/source/refs/contributing.html
-->

Since many of us are working, it makes sense to have a spell checker to ensure we have the right words everywhere. The PR adds [codespell](https://github.com/codespell-project/codespell) to the pre-commit file that allows checking for typos/spellings in the repository.

The tool is available under a GPL-2.0 license and is fetched using its PyPi release. The repo's BSD-3 is compatible with  GNU-GPL family of licenses.  We do not modify any of the codespell's source code. The license file is included in the repository for the sake of completion.

<!-- As a practice, it is recommended to open an issue to have discussions on the proposed pull request.
This makes it easier for the community to keep track of what is being developed or added, and if a given feature
is demanded by more than one party. -->

## Type of change

<!-- As you go through the list, delete the ones that are not applicable. -->

- New feature (non-breaking change which adds functionality)

<!--
Example:

| Before | After |
| ------ | ----- |
| _gif/png before_ | _gif/png after_ |

To upload images to a PR -- simply drag and drop an image while in edit mode and it should upload the image directly. You can then paste that source into the above before/after sections.
-->

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./orbit.sh --format`
- [x] 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

<!--
As you go through the checklist above, you can mark something as done by putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->

Setuptools 67.0 onwards does not support malformed strings. As mentioned in their release notes, users must conform to PEP specifications strictly (i.e. will result in build errors if not complied). 

The MR fixes the `setuptools` package version to be <=66, so that the users can still continue using the gym==0.21.0. Though long-term we should switch to using Gymnasium. Additionally, it removes the malformed strings in Orbit packages to follow the new `setuptools`.

* adds info on orbit in isaac ecosystem
* simplifies developer guide
* updates roadmap
* adds isaacsim version note
* fixes the bibtex entry

* updates envs to pass all keyword args to isaac-env
* adds rendering modes to IsaacEnv
* fixes loading of extensions for viewport rendering
* adds unit test for recording videos of all envs
* adds physx spellings to vscode settings.json
* adds video logging to all workflow scripts
* updates changelog and version
* adds function to print callables in dict
* adds documentation on env wrappers

---------
Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>

* adds initialize to rmpflow controller
* adds demo script to play rmpflow
* fixes bugs in dealing with multiple command types
* adds right end-effector frame for franka lula
* adds demo script for rmpflow
* updates config and changelog

---------
Co-authored-by: Mayank Mittal <mittalma@leggedrobotics.com>

* Enlarges the hard-coded success range from 0.002 to 0.02
* Updates observations in BC configs from `object_positions` to `object_relative_tool_positions`

* Adds `se3_gamepad` and `se2_gamepad`
* Update changelog and version
* Adds unsubscribing when destroying

---------
Co-authored-by: Mayank Mittal <mittalma@leggedrobotics.com>

add dataclass decorator to SingleArmCfg.DataInfoCfg class

* updates documentation for creating a new env
* updates gitignore for orbit_assets

---------
Co-authored-by: Mayank Mittal <mittalma@leggedrobotics.com>

* fixes sb3 configs for missing agent seed
* fixes encoding issue when loading yaml configs
* adds launch.json task for running environment

* dealing with negative w component in quat
* fix bug on subtract_fram_transform by applying the rotation
* update version and changelog

* fixes the feet air time in `LeggedRobot` class
* fixes set joint efforts on reset in `RobotBase` class
* fix gripper mimic duplication in `GripperActuatorGroup` class
* updates version and changelog

* adds creating conda envronment using orbit.sh (-c)
* fixes running of formatter in orbit.sh (-f)
* adds docs building to orbit.sh (-d)
* updates docs with orbit.sh help, vscode instructions and state machine sample

* adds physics material for tool sites in single arm
* adds collision props settings to robot base
* makes zero correspond to open command
* adds collision props to franka, anymal and a1
* cleans up the setting of prim cfg in object classes
* tunes lift env to work with rsl-rl
* enable self collisions in franka
* adds units for physics-related params
* tunes ppo for lift to work
* updates changelog
* adds warp-based state machine for lift environment

* fixes the indices used for arm quantities in mobile manipulator class
* updates changelog

* adds utility to generate vscode settings with extra python paths
* adds flag to create vscode settings in orbit.sh
* updates docs with vscode flag
* updates comment in gitignore