added script to download environment mesh files from zenodo. Installs as a CLI script

Author: lukestroh

pybullet_tree_sim/utils/mesh_downloader.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+import os
+import requests
+from tqdm import tqdm
+import zipfile
+
+
+_here = os.path.abspath(__file__)
+lib_path = os.path.dirname(os.path.dirname(_here))
+meshes_path = os.path.join(lib_path, "meshes")
+
+
+def get_filename_from_url(url: str) -> str:
+    local_filename = url.split('/')[-1]
+    return os.path.join(meshes_path, local_filename)
+
+
+def is_download_needed(target_file_path: str) -> bool:
+    if not os.path.exists(meshes_path):
+        os.mkdir(meshes_path)
+        return True
+    if not os.path.exists(os.path.join(meshes_path, 'trees')):
+        if not os.path.isfile(os.path.join(meshes_path, 'pybullet-tree-sim-meshes.zip')): # TODO: pass name into func
+            return True
+        else:
+            return False
+    else:
+        return False
+
+def is_unzip_needed(target_file_path: str) -> bool:
+    if not os.path.exists(os.path.join(meshes_path, 'trees')):
+        return True
+    else:
+        return False
+
+
+def download_file(url: str, target_file_path: str) -> bool:
+    try:
+        # NOTE the stream=True parameter below
+        with requests.get(url, stream=True) as r:
+            r.raise_for_status()
+            total_size = int(r.headers.get("content-length", 0))
+            with tqdm(total=total_size, unit='B', unit_scale=True) as progress_bar:
+                with open(target_file_path, 'wb') as f:
+                    for chunk in r.iter_content(chunk_size=8192): 
+                        # If you have chunk encoded response uncomment if
+                        # and set chunk_size parameter to None.
+                        # if chunk: 
+                        progress_bar.update(len(chunk))
+                        f.write(chunk)
+        
+                    return True
+    
+    except Exception as e:
+        print(f'{e}')
+        return False
+    
+
+
+def unzip(zip_file: str):
+    with zipfile.ZipFile(zip_file, 'r') as zipper:
+        zipper.extractall(os.path.dirname(zip_file))
+    return
+
+
+def main():
+    url = "https://zenodo.org/records/14991250/files/pybullet-tree-sim-meshes.zip"
+
+    file_abs_path = get_filename_from_url(url=url)
+
+    download_needed = is_download_needed(target_file_path=file_abs_path)
+    if download_needed:
+        download_file(url=url, target_file_path=file_abs_path)
+    
+    unzip_needed = is_unzip_needed(target_file_path=file_abs_path)
+    if unzip_needed:
+        unzip(zip_file=file_abs_path)
+    return
+
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -2,6 +2,14 @@
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
+# [tool.hatch.metadata]
+# allow-direct-references = true
+
+# [tool.hatch.build.hooks.custom]
+# path = "pybullet_tree_sim/utils/mesh_downloader.py"
+
+
+
 [project]
 name = "pybullet_tree_sim"
 version = "0.0.1"
@@ -28,7 +36,12 @@ dependencies = [
     "pybullet==3.2.6",
     "pywavefront",
     "pyyaml",
+    'requests',
     "scikit-image",
+    'tqdm',
     "xacro",
     "zenlog",
 ]
+
+[project.scripts]
+mesh_downloader = 'pybullet_tree_sim.utils.mesh_downloader:main'