Unverified Commit f71340eb authored by Mayank Mittal's avatar Mayank Mittal Committed by GitHub

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
parent 63f585fc
...@@ -19,17 +19,17 @@ in robotics research (such as RL, learning from demonstrations, and motion plann ...@@ -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. 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 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 * [17.04.2024] [**v0.3.0**](https://github.com/NVIDIA-Omniverse/orbit/releases/tag/v0.3.0):
several improvements and fixes to enhance the modularity and user-friendliness of the framework. We have added Several improvements and bug fixes to the framework. Includes cabinet opening and dexterous manipulation environments,
several new environments, especially for legged locomotion, and are in the process of adding new environments. terrain-aware patch sampling, and animation recording.
Feel free to explore the latest changes and updates. We appreciate your ongoing support and contributions! * [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
For more details, please check the post here: [#106](https://github.com/NVIDIA-Omniverse/Orbit/discussions/106) procedural terrain generation, warp-based custom ray-casters, and legged-locomotion environments.
## Contributing to Orbit ## Contributing to Orbit
......
...@@ -29,7 +29,7 @@ project = "orbit" ...@@ -29,7 +29,7 @@ project = "orbit"
copyright = "2022-2024, The ORBIT Project Developers." copyright = "2022-2024, The ORBIT Project Developers."
author = "The ORBIT Project Developers." author = "The ORBIT Project Developers."
version = "0.2.0" version = "0.3.0"
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
...@@ -203,7 +203,7 @@ html_css_files = ["custom.css"] ...@@ -203,7 +203,7 @@ html_css_files = ["custom.css"]
html_theme_options = { html_theme_options = {
"collapse_navigation": True, "collapse_navigation": True,
"repository_url": "https://github.com/NVIDIA-Omniverse/Orbit", "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_repository_button": True,
"use_issues_button": True, "use_issues_button": True,
"use_edit_page_button": True, "use_edit_page_button": True,
......
...@@ -3,7 +3,9 @@ Extensions Changelog ...@@ -3,7 +3,9 @@ Extensions Changelog
All notable changes to this project are documented in this file. The format is based on 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 `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 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 ``docs`` directory of the extension. The changelog for each extension is also included in
......
...@@ -20,8 +20,8 @@ Installing Isaac Sim ...@@ -20,8 +20,8 @@ Installing Isaac Sim
.. caution:: .. caution::
We have dropped support for Isaac Sim versions 2022.2 and below. We recommend using the latest Isaac Sim We have dropped support for Isaac Sim versions 2023.1.0 and below. We recommend using the latest
2023.1 releases (``2023.1.0-hotfix.1`` or ``2023.1.1``). Isaac Sim 2023.1.1 release.
For more information, please refer to the For more information, please refer to the
`Isaac Sim release notes <https://docs.omniverse.nvidia.com/isaacsim/latest/release_notes.html>`__. `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 ...@@ -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>`__. `here <https://docs.omniverse.nvidia.com/isaacsim/latest/installation/requirements.html>`__.
.. note:: .. 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. 20.04LTS with NVIDIA driver 525.147.
Configuring the environment variables Configuring the environment variables
...@@ -179,6 +179,9 @@ utilities to manage extensions: ...@@ -179,6 +179,9 @@ utilities to manage extensions:
Setting up the environment 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 The executable ``orbit.sh`` automatically fetches the python bundled with Isaac
Sim, using ``./orbit.sh -p`` command (unless inside a virtual environment). This executable 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 behaves like a python executable, and can be used to run any python script or
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment