Simplified folder structure

utiasDSL · Oct 21, 2023 · 3f6dae5 · 3f6dae5
1 parent 1a60226
commit 3f6dae5
Show file tree

Hide file tree

Showing 23 changed files with 10 additions and 12 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,8 +4,6 @@ examples/debug.py
 examples/test.py
 
 # NumPy saves and videos
-files/logs/*.npy
-files/videos/*.mp4
 results/
 tmp/
 

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ This is a minimalist refactoring of the original `gym-pybullet-drones` repositor
 
 > **NOTE**: if you prefer to access the original codebase, presented at IROS in 2021, please `git checkout [paper|master]` after cloning the repo, and refer to the corresponding `README.md`'s.
 
-<img src="files/readme_images/helix.gif" alt="formation flight" width="350"> <img src="files/readme_images/helix.png" alt="control info" width="450">
+<img src="gym_pybullet_drones/assets/helix.gif" alt="formation flight" width="350"> <img src="gym_pybullet_drones/assets/helix.png" alt="control info" width="450">
 
 ## Installation
 

diff --git a/files/logs/foo.txt b/files/logs/foo.txt
diff --git a/files/readme_images/2020.gif b/files/readme_images/2020.gif
diff --git a/files/readme_images/dep.gif b/files/readme_images/dep.gif
diff --git a/files/readme_images/downwash.gif b/files/readme_images/downwash.gif
diff --git a/files/readme_images/downwash.png b/files/readme_images/downwash.png
diff --git a/files/readme_images/rgb.gif b/files/readme_images/rgb.gif
diff --git a/files/readme_images/seg.gif b/files/readme_images/seg.gif
diff --git a/gym_pybullet_drones/assets/beta.txt → ...bullet_drones/assets/beta-presets-bak.txt b/gym_pybullet_drones/assets/beta.txt → ...bullet_drones/assets/beta-presets-bak.txt
diff --git a/gym_pybullet_drones/assets/beta.csv → gym_pybullet_drones/assets/beta-traj.csv b/gym_pybullet_drones/assets/beta.csv → gym_pybullet_drones/assets/beta-traj.csv
diff --git a/files/videos/ffmpeg_png2mp4.sh → gym_pybullet_drones/assets/ffmpeg_png2mp4.sh b/files/videos/ffmpeg_png2mp4.sh → gym_pybullet_drones/assets/ffmpeg_png2mp4.sh
diff --git a/files/readme_images/helix.gif → gym_pybullet_drones/assets/helix.gif b/files/readme_images/helix.gif → gym_pybullet_drones/assets/helix.gif
diff --git a/files/readme_images/helix.png → gym_pybullet_drones/assets/helix.png b/files/readme_images/helix.png → gym_pybullet_drones/assets/helix.png
diff --git a/gym_pybullet_drones/envs/BaseAviary.py b/gym_pybullet_drones/envs/BaseAviary.py
@@ -61,7 +61,7 @@ def __init__(self,
         gui : bool, optional
             Whether to use PyBullet's GUI.
         record : bool, optional
-            Whether to save a video of the simulation in folder `files/videos/`.
+            Whether to save a video of the simulation.
         obstacles : bool, optional
             Whether to add obstacles to the simulation.
         user_debug_gui : bool, optional

diff --git a/gym_pybullet_drones/envs/BaseRLAviary.py b/gym_pybullet_drones/envs/BaseRLAviary.py
@@ -54,7 +54,7 @@ def __init__(self,
         gui : bool, optional
             Whether to use PyBullet's GUI.
         record : bool, optional
-            Whether to save a video of the simulation in folder `files/videos/`.
+            Whether to save a video of the simulation.
         obs : ObservationType, optional
             The type of observation space (kinematic information or vision)
         act : ActionType, optional

diff --git a/gym_pybullet_drones/envs/BetaAviary.py b/gym_pybullet_drones/envs/BetaAviary.py
@@ -59,7 +59,7 @@ def __init__(self,
         gui : bool, optional
             Whether to use PyBullet's GUI.
         record : bool, optional
-            Whether to save a video of the simulation in folder `files/videos/`.
+            Whether to save a video of the simulation.
         obstacles : bool, optional
             Whether to add obstacles to the simulation.
         user_debug_gui : bool, optional

diff --git a/gym_pybullet_drones/envs/CtrlAviary.py b/gym_pybullet_drones/envs/CtrlAviary.py
@@ -47,7 +47,7 @@ def __init__(self,
         gui : bool, optional
             Whether to use PyBullet's GUI.
         record : bool, optional
-            Whether to save a video of the simulation in folder `files/videos/`.
+            Whether to save a video of the simulation.
         obstacles : bool, optional
             Whether to add obstacles to the simulation.
         user_debug_gui : bool, optional

diff --git a/gym_pybullet_drones/envs/HoverAviary.py b/gym_pybullet_drones/envs/HoverAviary.py
@@ -41,7 +41,7 @@ def __init__(self,
         gui : bool, optional
             Whether to use PyBullet's GUI.
         record : bool, optional
-            Whether to save a video of the simulation in folder `files/videos/`.
+            Whether to save a video of the simulation.
         obs : ObservationType, optional
             The type of observation space (kinematic information or vision)
         act : ActionType, optional

diff --git a/gym_pybullet_drones/envs/LeaderFollowerAviary.py b/gym_pybullet_drones/envs/LeaderFollowerAviary.py
@@ -47,7 +47,7 @@ def __init__(self,
         gui : bool, optional
             Whether to use PyBullet's GUI.
         record : bool, optional
-            Whether to save a video of the simulation in folder `files/videos/`.
+            Whether to save a video of the simulation.
         obs : ObservationType, optional
             The type of observation space (kinematic information or vision)
         act : ActionType, optional

diff --git a/gym_pybullet_drones/envs/VelocityAviary.py b/gym_pybullet_drones/envs/VelocityAviary.py
@@ -49,7 +49,7 @@ def __init__(self,
         gui : bool, optional
             Whether to use PyBullet's GUI.
         record : bool, optional
-            Whether to save a video of the simulation in folder `files/videos/`.
+            Whether to save a video of the simulation.
         obstacles : bool, optional
             Whether to add obstacles to the simulation.
         user_debug_gui : bool, optional

diff --git a/gym_pybullet_drones/examples/beta.py b/gym_pybullet_drones/examples/beta.py
@@ -88,7 +88,7 @@ def run(
                     )
 
     #### Run the simulation ####################################
-    with open("../assets/beta.csv", mode='r') as csv_file:
+    with open("../assets/beta-traj.csv", mode='r') as csv_file:
         csv_reader = csv.DictReader(csv_file)
         trajectory1 = iter([{
             "pos": np.array([

diff --git a/pypi_description.md b/pypi_description.md
@@ -1,6 +1,6 @@
 # gym-pybullet-drones
 
-[Simple](https://en.wikipedia.org/wiki/KISS_principle) OpenAI [Gym environment](https://gym.openai.com/envs/#classic_control) based on [PyBullet](https://github.com/bulletphysics/bullet3) for multi-agent reinforcement learning with quadrotors 
+[Simple](https://en.wikipedia.org/wiki/KISS_principle) OpenAI [Gym environment](https://gym.openai.com/envs/#classic_control) based on [PyBullet](https://github.com/bulletphysics/bullet3) for multi-agent reinforcement learning with quadrotors
 
 Find the project's published results at [Learning to Fly—a Gym Environment with PyBullet Physics for Reinforcement Learning of Multi-agent Quadcopter Control](https://ieeexplore.ieee.org/abstract/document/9635857).