Skip to content

Commit f71340e

Browse files
authored
Updates versioning of the framework to v0.3 release (#507)
# 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
1 parent 63f585f commit f71340e

File tree

5 files changed

+20
-15
lines changed

5 files changed

+20
-15
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ in robotics research (such as RL, learning from demonstrations, and motion plann
1919
simulation capabilities for photo-realistic scenes and fast and accurate simulation.
2020

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

24-
## 🎉 Announcement (22.12.2023)
24+
## Announcements
2525

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

30-
Feel free to explore the latest changes and updates. We appreciate your ongoing support and contributions!
31-
32-
For more details, please check the post here: [#106](https://github.com/NVIDIA-Omniverse/Orbit/discussions/106)
30+
* [22.12.2023] [**v0.2.0**](https://github.com/NVIDIA-Omniverse/orbit/releases/tag/v0.2.0):
31+
Significant breaking updates to enhance the modularity and user-friendliness of the framework. Also includes
32+
procedural terrain generation, warp-based custom ray-casters, and legged-locomotion environments.
3333

3434
## Contributing to Orbit
3535

VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.2.0
1+
0.3.0

docs/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
copyright = "2022-2024, The ORBIT Project Developers."
3030
author = "The ORBIT Project Developers."
3131

32-
version = "0.2.0"
32+
version = "0.3.0"
3333

3434
# -- General configuration ---------------------------------------------------
3535

@@ -203,7 +203,7 @@
203203
html_theme_options = {
204204
"collapse_navigation": True,
205205
"repository_url": "https://github.com/NVIDIA-Omniverse/Orbit",
206-
"announcement": "We have now released v0.2.0! Please use the latest version for the best experience.",
206+
"announcement": "We have now released v0.3.0! Please use the latest version for the best experience.",
207207
"use_repository_button": True,
208208
"use_issues_button": True,
209209
"use_edit_page_button": True,

docs/source/refs/changelog.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ Extensions Changelog
33

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

810
Each extension has its own changelog. The changelog for each extension is located in the
911
``docs`` directory of the extension. The changelog for each extension is also included in

docs/source/setup/installation.rst

+6-3
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Installing Isaac Sim
2020

2121
.. caution::
2222

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

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

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

4343
Configuring the environment variables
@@ -179,6 +179,9 @@ utilities to manage extensions:
179179
Setting up the environment
180180
~~~~~~~~~~~~~~~~~~~~~~~~~~
181181

182+
.. attention::
183+
This step is optional. If you are using the bundled python with Isaac Sim, you can skip this step.
184+
182185
The executable ``orbit.sh`` automatically fetches the python bundled with Isaac
183186
Sim, using ``./orbit.sh -p`` command (unless inside a virtual environment). This executable
184187
behaves like a python executable, and can be used to run any python script or

0 commit comments

Comments
 (0)