documentation refactor to gz

andreaostuni · Feb 3, 2024 · 64e98bc · 64e98bc
1 parent e4740cd
commit 64e98bc
Show file tree

Hide file tree

Showing 49 changed files with 274 additions and 274 deletions.
diff --git a/.docker/cicd-master.Dockerfile b/.docker/cicd-master.Dockerfile
@@ -1,7 +1,7 @@
 ARG from=diegoferigo/gym-gz:base
 FROM ${from}
 
-# Install ignition gazebo
+# Install gz sim
 ARG gazebo_codename="garden"
 RUN echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" \
         > /etc/apt/sources.list.d/gazebo-stable.list &&\

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -15,11 +15,11 @@ labels: issue::type::bug
 - [ ] I've already searched similar [issues][Issues] and [discussions][Discussions]
 - [ ] I've already updated to the most recent supported [release][Releases] (either Stable or Nightly)
 
-[Issues]: https://github.com/robotology/gym-ignition/issues
-[Releases]: https://github.com/robotology/gym-ignition/releases
-[FAQ]: https://robotology.github.io/gym-ignition/master/info/faq.html
-[Discussions]: https://github.com/robotology/gym-ignition/discussions
-[Support Policy]: https://robotology.github.io/gym-ignition/master/installation/support_policy.html
+[Issues]: https://github.com/andreaostuni/gym-gz/issues
+[Releases]: https://github.com/andreaostuni/gym-gz/releases
+[FAQ]: https://andreaostuni.github.io/gym-gz/master/info/faq.html
+[Discussions]: https://github.com/andreaostuni/gym-gz/discussions
+[Support Policy]: https://andreaostuni.github.io/gym-gz/master/installation/support_policy.html
 
 ## Description:
 
@@ -53,7 +53,7 @@ Content
 - OS: <!-- Insert the distribution, e.g. Ubuntu 20.04 -->
 - GPU: <!-- Insert your GPU, e.g. Intel XXX integrated -->    
 - Python: <!-- Insert the active Python version and provider, e.g. 3.8.X from virtualenv -->
-- Version: <!-- Insert the installed version of gym-ignition and scenario, e.g. v1.2.0 -->
+- Version: <!-- Insert the installed version of gym-gz and scenario, e.g. v1.2.0 -->
 - Channel:
   - [ ] Stable
   - [ ] Nightly

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -8,7 +8,7 @@ labels: issue::type::enhancement
 
 ⚠️ If you're not sure on the specifics of the feature or would like a broader discussion, please consider posting a proposal to [Discussions][Discussions] instead.
 
-[Discussions]: https://github.com/robotology/gym-ignition/discussions
+[Discussions]: https://github.com/andreaostuni/gym-gz/discussions
 
 ## Summary
 

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <p align="center">
-<h1 align="center">gym-ignition</h1>
+<h1 align="center">gym-gz</h1>
 </p>
 
 <div align="center">
@@ -56,40 +56,40 @@
 
 ## Description
 
-**gym-ignition** is a framework to create **reproducible robotics environments** for reinforcement learning research.
+**gym-gz** is a framework to create **reproducible robotics environments** for reinforcement learning research.
 
-It is based on the [ScenarIO](scenario/) project which provides the low-level APIs to interface with the Ignition Gazebo simulator.
+It is based on the [ScenarIO](scenario/) project which provides the low-level APIs to interface with the Gz sim simulator.
 By default, RL environments share a lot of boilerplate code, e.g. for initializing the simulator or structuring the classes
 to expose the `gym.Env` interface.
-Gym-ignition provides the [`Task`](python/gym_ignition/base/task.py) and [`Runtime`](python/gym_ignition/base/runtime.py)
+Gym-gz provides the [`Task`](python/gym_gz/base/task.py) and [`Runtime`](python/gym_gz/base/runtime.py)
 abstractions that help you focusing on the development of the decision-making logic rather than engineering.
-It includes [randomizers](python/gym_ignition/randomizers) to simplify the implementation of domain randomization
+It includes [randomizers](python/gym_gz/randomizers) to simplify the implementation of domain randomization
 of models, physics, and tasks.
-Gym-ignition also provides powerful dynamics algorithms compatible with both fixed-base and floating-based robots by
+Gym-gz also provides powerful dynamics algorithms compatible with both fixed-base and floating-based robots by
 exploiting [robotology/idyntree](https://github.com/robotology/idyntree/) and exposing
-[high-level functionalities](python/gym_ignition/rbd/idyntree).
+[high-level functionalities](python/gym_gz/rbd/idyntree).
 
-Gym-ignition does not provide out-of-the-box environments ready to be used.
+Gym-gz does not provide out-of-the-box environments ready to be used.
 Rather, its aim is simplifying and streamlining their development.
 Nonetheless, for illustrative purpose, it includes canonical examples in the
-[`gym_ignition_environments`](python/gym_ignition_environments) package.
+[`gym_gz_environments`](python/gym_gz_environments) package.
 
 Visit the [website][website] for more information about the project.
 
-[website]: https://robotology.github.io/gym-ignition
+[website]: https://robotology.github.io/gym-gz
 
 ## Installation
 
 1. First, follow the installation instructions of [ScenarIO](scenario/).
-2. `pip install gym-ignition`, preferably in a [virtual environment](https://docs.python.org/3.8/tutorial/venv.html).
+2. `pip install gym-gz`, preferably in a [virtual environment](https://docs.python.org/3.8/tutorial/venv.html).
 
 ## Contributing
 
 You can visit our community forum hosted in [GitHub Discussions](https://github.com/robotology/gym-ignition/discussions).
 Even without coding skills, replying user's questions is a great way of contributing.
-If you use gym-ignition in your application and want to show it off, visit the
+If you use gym-gz in your application and want to show it off, visit the
 [Show and tell](https://github.com/robotology/gym-ignition/discussions/categories/show-and-tell) section!
-You can advertise there your environments created with gym-ignition.
+You can advertise there your environments created with gym-gz.
 
 Pull requests are welcome.
 
@@ -115,4 +115,4 @@ first to propose what you would like to change.
 
 ---
 
-**Disclaimer:** Gym-ignition is an independent project and is not related by any means to OpenAI and Open Robotics.
+**Disclaimer:** Gym-gz is an independent project and is not related by any means to OpenAI and Open Robotics.
diff --git a/...ents/gym_ignition_environments.models.rst → ...vironments/gym_gz_environments.models.rst b/...ents/gym_ignition_environments.models.rst → ...vironments/gym_gz_environments.models.rst
@@ -1,5 +1,5 @@
 gym\_gz\_environments.models
-==================================
+============================
 
 .. automodule:: gym_gz_environments.models
    :members:
@@ -8,31 +8,31 @@ gym\_gz\_environments.models
 
 
 gym\_gz\_environments.models.cartpole
--------------------------------------------
+-------------------------------------
 
 .. automodule:: gym_gz_environments.models.cartpole
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz\_environments.models.icub
----------------------------------------
+---------------------------------
 
 .. automodule:: gym_gz_environments.models.icub
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz\_environments.models.panda
-----------------------------------------
+----------------------------------
 
 .. automodule:: gym_gz_environments.models.panda
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz\_environments.models.pendulum
--------------------------------------------
+-------------------------------------
 
 .. automodule:: gym_gz_environments.models.pendulum
    :members:

diff --git a/...gym_ignition_environments.randomizers.rst → ...ments/gym_gz_environments.randomizers.rst b/...gym_ignition_environments.randomizers.rst → ...ments/gym_gz_environments.randomizers.rst
@@ -1,5 +1,5 @@
 gym\_gz\_environments.randomizers
-=======================================
+=================================
 
 .. automodule:: gym_gz_environments.randomizers
    :members:
@@ -8,15 +8,15 @@ gym\_gz\_environments.randomizers
 
 
 gym\_gz\_environments.randomizers.cartpole
-------------------------------------------------
+------------------------------------------
 
 .. automodule:: gym_gz_environments.randomizers.cartpole
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz\_environments.randomizers.cartpole\_no\_rand
-----------------------------------------------------------
+----------------------------------------------------
 
 .. automodule:: gym_gz_environments.randomizers.cartpole_no_rand
    :members:

diff --git a/...nvironments/gym_ignition_environments.rst → ...m-gz-environments/gym_gz_environments.rst b/...nvironments/gym_ignition_environments.rst → ...m-gz-environments/gym_gz_environments.rst
@@ -1,5 +1,5 @@
 gym\_gz\_environments
-===========================
+=====================
 
 .. automodule:: gym_gz_environments
    :members:

diff --git a/...ments/gym_ignition_environments.tasks.rst → ...nvironments/gym_gz_environments.tasks.rst b/...ments/gym_ignition_environments.tasks.rst → ...nvironments/gym_gz_environments.tasks.rst
@@ -1,5 +1,5 @@
 gym\_gz\_environments.tasks
-=================================
+===========================
 
 .. automodule:: gym_gz_environments.tasks
    :members:
@@ -8,31 +8,31 @@ gym\_gz\_environments.tasks
 
 
 gym\_gz\_environments.tasks.cartpole\_continuous\_balancing
------------------------------------------------------------------
+-----------------------------------------------------------
 
 .. automodule:: gym_gz_environments.tasks.cartpole_continuous_balancing
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz\_environments.tasks.cartpole\_continuous\_swingup
----------------------------------------------------------------
+---------------------------------------------------------
 
 .. automodule:: gym_gz_environments.tasks.cartpole_continuous_swingup
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz\_environments.tasks.cartpole\_discrete\_balancing
----------------------------------------------------------------
+---------------------------------------------------------
 
 .. automodule:: gym_gz_environments.tasks.cartpole_discrete_balancing
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz\_environments.tasks.pendulum\_swingup
----------------------------------------------------
+---------------------------------------------
 
 .. automodule:: gym_gz_environments.tasks.pendulum_swingup
    :members:

diff --git a/...apidoc/gym-ignition/gym_ignition.base.rst → docs/sphinx/apidoc/gym-gz/gym_gz.base.rst b/...apidoc/gym-ignition/gym_ignition.base.rst → docs/sphinx/apidoc/gym-gz/gym_gz.base.rst
@@ -1,5 +1,5 @@
 gym\_gz.base
-==================
+============
 
 .. automodule:: gym_gz.base
    :members:
@@ -8,15 +8,15 @@ gym\_gz.base
 
 
 gym\_gz.base.runtime
---------------------------
+--------------------
 
 .. automodule:: gym_gz.base.runtime
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz.base.task
------------------------
+-----------------
 
 .. automodule:: gym_gz.base.task
    :members:

diff --git a/...-ignition/gym_ignition.context.gazebo.rst → ...x/apidoc/gym-gz/gym_gz.context.gazebo.rst b/...-ignition/gym_ignition.context.gazebo.rst → ...x/apidoc/gym-gz/gym_gz.context.gazebo.rst
@@ -1,5 +1,5 @@
 gym\_gz.context.gazebo
-============================
+======================
 
 .. automodule:: gym_gz.context.gazebo
    :members:
@@ -8,15 +8,15 @@ gym\_gz.context.gazebo
 
 
 gym\_gz.context.gazebo.controllers
-----------------------------------------
+----------------------------------
 
 .. automodule:: gym_gz.context.gazebo.controllers
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz.context.gazebo.plugin
------------------------------------
+-----------------------------
 
 .. automodule:: gym_gz.context.gazebo.plugin
    :members:

diff --git a/...doc/gym-ignition/gym_ignition.context.rst → docs/sphinx/apidoc/gym-gz/gym_gz.context.rst b/...doc/gym-ignition/gym_ignition.context.rst → docs/sphinx/apidoc/gym-gz/gym_gz.context.rst
@@ -1,5 +1,5 @@
 gym\_gz.context
-=====================
+===============
 
 .. automodule:: gym_gz.context
    :members:

diff --git a/...nition/gym_ignition.randomizers.model.rst → ...pidoc/gym-gz/gym_gz.randomizers.model.rst b/...nition/gym_ignition.randomizers.model.rst → ...pidoc/gym-gz/gym_gz.randomizers.model.rst
@@ -1,5 +1,5 @@
 gym\_gz.randomizers.model
-===============================
+=========================
 
 .. automodule:: gym_gz.randomizers.model
    :members:
@@ -8,7 +8,7 @@ gym\_gz.randomizers.model
 
 
 gym\_gz.randomizers.model.sdf
------------------------------------
+-----------------------------
 
 .. automodule:: gym_gz.randomizers.model.sdf
    :members:

diff --git a/...tion/gym_ignition.randomizers.physics.rst → ...doc/gym-gz/gym_gz.randomizers.physics.rst b/...tion/gym_ignition.randomizers.physics.rst → ...doc/gym-gz/gym_gz.randomizers.physics.rst
@@ -1,5 +1,5 @@
 gym\_gz.randomizers.physics
-=================================
+===========================
 
 .. automodule:: gym_gz.randomizers.physics
    :members:
@@ -8,7 +8,7 @@ gym\_gz.randomizers.physics
 
 
 gym\_gz.randomizers.physics.dart
---------------------------------------
+--------------------------------
 
 .. automodule:: gym_gz.randomizers.physics.dart
    :members:

diff --git a/...gym-ignition/gym_ignition.randomizers.rst → ...hinx/apidoc/gym-gz/gym_gz.randomizers.rst b/...gym-ignition/gym_ignition.randomizers.rst → ...hinx/apidoc/gym-gz/gym_gz.randomizers.rst
@@ -1,5 +1,5 @@
 gym\_gz.randomizers
-=========================
+===================
 
 .. automodule:: gym_gz.randomizers
    :members:
@@ -15,15 +15,15 @@ gym\_gz.randomizers
 
 
 gym\_gz.randomizers.abc
------------------------------
+-----------------------
 
 .. automodule:: gym_gz.randomizers.abc
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz.randomizers.gazebo\_env\_randomizer
--------------------------------------------------
+-------------------------------------------
 
 .. automodule:: gym_gz.randomizers.gazebo_env_randomizer
    :members:

diff --git a/...ym-ignition/gym_ignition.rbd.idyntree.rst → ...inx/apidoc/gym-gz/gym_gz.rbd.idyntree.rst b/...ym-ignition/gym_ignition.rbd.idyntree.rst → ...inx/apidoc/gym-gz/gym_gz.rbd.idyntree.rst
@@ -1,5 +1,5 @@
 gym\_gz.rbd.idyntree
-==========================
+====================
 
 .. automodule:: gym_gz.rbd.idyntree
    :members:
@@ -8,31 +8,31 @@ gym\_gz.rbd.idyntree
 
 
 gym\_gz.rbd.idyntree.helpers
-----------------------------------
+----------------------------
 
 .. automodule:: gym_gz.rbd.idyntree.helpers
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz.rbd.idyntree.inverse\_kinematics\_nlp
----------------------------------------------------
+---------------------------------------------
 
 .. automodule:: gym_gz.rbd.idyntree.inverse_kinematics_nlp
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz.rbd.idyntree.kindyncomputations
----------------------------------------------
+---------------------------------------
 
 .. automodule:: gym_gz.rbd.idyntree.kindyncomputations
    :members:
    :undoc-members:
    :show-inheritance:
 
 gym\_gz.rbd.idyntree.numpy
---------------------------------
+--------------------------
 
 .. automodule:: gym_gz.rbd.idyntree.numpy
    :members: