Skip to content

Commit

Permalink
Updates versioning of the framework to v0.3 release (#507)
Browse files Browse the repository at this point in the history
# Description

This MR updates the docs for versioning of the framework to 0.3.0.

## 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
- [x] I have run all the tests with `./orbit.sh --test` and they pass
- [ ] 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
  • Loading branch information
Mayankm96 committed Apr 17, 2024
1 parent 63f585f commit f71340e
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 15 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ in robotics research (such as RL, learning from demonstrations, and motion plann
simulation capabilities for photo-realistic scenes and fast and accurate simulation.

Please refer to our [documentation page](https://isaac-orbit.github.io/orbit) to learn more about the
installation steps, features, tutorials, and how to setup your own project with Orbit.
installation steps, features, tutorials, and how to set up your project with Orbit.

## 🎉 Announcement (22.12.2023)
## Announcements

We're excited to announce merging of our latest development branch into the main branch! This update introduces
several improvements and fixes to enhance the modularity and user-friendliness of the framework. We have added
several new environments, especially for legged locomotion, and are in the process of adding new environments.
* [17.04.2024] [**v0.3.0**](https://github.com/NVIDIA-Omniverse/orbit/releases/tag/v0.3.0):
Several improvements and bug fixes to the framework. Includes cabinet opening and dexterous manipulation environments,
terrain-aware patch sampling, and animation recording.

Feel free to explore the latest changes and updates. We appreciate your ongoing support and contributions!

For more details, please check the post here: [#106](https://github.com/NVIDIA-Omniverse/Orbit/discussions/106)
* [22.12.2023] [**v0.2.0**](https://github.com/NVIDIA-Omniverse/orbit/releases/tag/v0.2.0):
Significant breaking updates to enhance the modularity and user-friendliness of the framework. Also includes
procedural terrain generation, warp-based custom ray-casters, and legged-locomotion environments.

## Contributing to Orbit

Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.2.0
0.3.0
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
copyright = "2022-2024, The ORBIT Project Developers."
author = "The ORBIT Project Developers."

version = "0.2.0"
version = "0.3.0"

# -- General configuration ---------------------------------------------------

Expand Down Expand Up @@ -203,7 +203,7 @@
html_theme_options = {
"collapse_navigation": True,
"repository_url": "https://github.com/NVIDIA-Omniverse/Orbit",
"announcement": "We have now released v0.2.0! Please use the latest version for the best experience.",
"announcement": "We have now released v0.3.0! Please use the latest version for the best experience.",
"use_repository_button": True,
"use_issues_button": True,
"use_edit_page_button": True,
Expand Down
4 changes: 3 additions & 1 deletion docs/source/refs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ Extensions Changelog

All notable changes to this project are documented in this file. The format is based on
`Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`__ and this project adheres to
`Semantic Versioning <https://semver.org/spec/v2.0.0.html>`__.
`Semantic Versioning <https://semver.org/spec/v2.0.0.html>`__. For a broader information
about the changes in the framework, please refer to the
`release notes <https://github.com/NVIDIA-Omniverse/orbit/releases/>`__.

Each extension has its own changelog. The changelog for each extension is located in the
``docs`` directory of the extension. The changelog for each extension is also included in
Expand Down
9 changes: 6 additions & 3 deletions docs/source/setup/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Installing Isaac Sim

.. caution::

We have dropped support for Isaac Sim versions 2022.2 and below. We recommend using the latest Isaac Sim
2023.1 releases (``2023.1.0-hotfix.1`` or ``2023.1.1``).
We have dropped support for Isaac Sim versions 2023.1.0 and below. We recommend using the latest
Isaac Sim 2023.1.1 release.

For more information, please refer to the
`Isaac Sim release notes <https://docs.omniverse.nvidia.com/isaacsim/latest/release_notes.html>`__.
Expand All @@ -37,7 +37,7 @@ To check the minimum system requirements,refer to the documentation
`here <https://docs.omniverse.nvidia.com/isaacsim/latest/installation/requirements.html>`__.

.. note::
We have tested Orbit with Isaac Sim 2023.1.0-hotfix.1 release on Ubuntu
We have tested Orbit with Isaac Sim 2023.1.1 release on Ubuntu
20.04LTS with NVIDIA driver 525.147.

Configuring the environment variables
Expand Down Expand Up @@ -179,6 +179,9 @@ utilities to manage extensions:
Setting up the environment
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. attention::
This step is optional. If you are using the bundled python with Isaac Sim, you can skip this step.

The executable ``orbit.sh`` automatically fetches the python bundled with Isaac
Sim, using ``./orbit.sh -p`` command (unless inside a virtual environment). This executable
behaves like a python executable, and can be used to run any python script or
Expand Down

0 comments on commit f71340e

Please sign in to comment.