Chore(examples): adapt documentation

blenderproc/python/loader/HavenMaterialLoader.py

@@ -84,8 +84,8 @@ def load_haven_mat(folder_path: str = "resources/haven", used_assets: list = [],
 
 class HavenMaterialLoader:
     """
-    This class loads all textures obtained from https://texturehaven.com, use the script
-    (scripts/download_haven.py) to download all the textures to your pc.
+    This class loads all textures obtained from https://texturehaven.com, use 'blenderproc download haven'
+    to download all the textures to your pc.
 
     All textures here support Physically based rendering (PBR), which makes the textures more realistic.
 

blenderproc/scripts/visHdf5Files.py

@@ -2,7 +2,7 @@
 import h5py
 import argparse
 import numpy as np
-from matplotlib import pyplot as plt
+# from matplotlib import pyplot as plt
 import sys
 import json
 import re

examples/advanced/camera_depth_of_field/README.md

@@ -24,7 +24,7 @@ blenderproc run examples/advanced/camera_depth_of_field/main.py examples/resourc
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/advanced/camera_depth_of_field/output/0.hdf5
+blenderproc vis hdf5 examples/advanced/camera_depth_of_field/output/0.hdf5
 ```
 
 ## Implementation

examples/advanced/coco_annotations/README.md

@@ -19,24 +19,24 @@ blenderproc run examples/advanced/coco_annotations/main.py examples/resources/ca
 
 ### Visualizing Annotations
 
-You can use vis_coco_annotation.py with the following command to visualize the annotations blended over a rendered rgb image:
+You can use vis coco_annotation.py with the following command to visualize the annotations blended over a rendered rgb image:
 
 ```
-blenderproc vis_coco [-i <image index>] [-c <coco annotations json>] [-b <base folder of coco json and image files>]
+blenderproc vis coco [-i <image index>] [-c <coco annotations json>] [-b <base folder of coco json and image files>]
 ```
 
 ### Working Examples
 
 With specific values:
 
 ```
-blenderproc vis_coco -i 1 -c coco_annotations.json -b examples/advanced/coco_annotations/output/coco_data
+blenderproc vis coco -i 1 -c coco_annotations.json -b examples/advanced/coco_annotations/output/coco_data
 ```
 
 Above are also the default values, i.e. for the same result call:
 
 ```
-blenderproc vis_coco
+blenderproc vis coco
 ```
 
 ## Implementation

examples/advanced/diffuse_color_image/README.md

@@ -23,7 +23,7 @@ blenderproc run examples/advanced/diffuse_color_image/main.py examples/resources
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/advanced/diffuse_color_image/output/0.hdf5
+blenderproc vis hdf5 examples/advanced/diffuse_color_image/output/0.hdf5
 ```
 
 ## Implementation

examples/advanced/dust/README.md

@@ -26,7 +26,7 @@ blenderproc run examples/advanced/dust/main.py resources/haven/models/ArmChair_0
 In the output folder you will find a series of `.hdf5` containers. These can be visualized with the script:
 
 ```
-blenderproc vis_hdf5 examples/datasets/haven/output/*.hdf5
+blenderproc vis hdf5 examples/datasets/haven/output/*.hdf5
 ``` 
 
 ## Implementation

examples/advanced/entity_displacement_modifier/README.md

@@ -23,7 +23,7 @@ blenderproc run examples/advanced/entity_displacement_modifier/main.py examples/
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/advanced/entity_displacement_modifier/output/0.hdf5
+blenderproc vis hdf5 examples/advanced/entity_displacement_modifier/output/0.hdf5
 ```
 
 ## Implementation

examples/advanced/material_randomizer/README.md

@@ -24,7 +24,7 @@ blenderproc run examples/advanced/material_randomizer/main.py examples/resources
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/advanced/material_randomizer/output/*.hdf5
+blenderproc vis hdf5 examples/advanced/material_randomizer/output/*.hdf5
 ```
 
 ## Implementation

examples/advanced/motion_blur_rolling_shutter/README.md

@@ -37,7 +37,7 @@ The configuration `config_motion_blur.yaml` creates pure motion blur, the config
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/advanced/motion_blur_rolling_shutter/output/0.hdf5
+blenderproc vis hdf5 examples/advanced/motion_blur_rolling_shutter/output/0.hdf5
 ```
 
 ## Implementation

examples/advanced/multi_render/README.md

@@ -25,7 +25,7 @@ blenderproc run examples/advanced/multi_render/main.py <PATH_TO_ShapeNetCore.v2>
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/advanced/multi_render/output/0.hdf5
+blenderproc vis hdf5 examples/advanced/multi_render/output/0.hdf5
 ```
 
 ## Steps

examples/advanced/object_pose_sampling/README.md

@@ -22,7 +22,7 @@ blenderproc run examples/advanced/object_pose_sampling/main.py examples/resource
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/advanced/object_pose_sampling/output/0.hdf5
+blenderproc vis hdf5 examples/advanced/object_pose_sampling/output/0.hdf5
 ```
 
 ## Implementation

examples/advanced/on_surface_object_sampling/README.md

@@ -22,7 +22,7 @@ blenderproc run examples/advanced/on_surface_object_sampling/main.py examples/re
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/advanced/on_surface_object_sampling/output/0.hdf5
+blenderproc vis hdf5 examples/advanced/on_surface_object_sampling/output/0.hdf5
 ```
 
 ## Implementation

examples/advanced/optical_flow/README.md

@@ -33,7 +33,7 @@ blenderproc run examples/advanced/optical_flow/main.py examples/advanced/optical
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/advanced/optical_flow/output/1.hdf5
+blenderproc vis hdf5 examples/advanced/optical_flow/output/1.hdf5
 ```
 
 ## Implementation

examples/advanced/physics_convex_decomposition/README.md

@@ -30,7 +30,7 @@ blenderproc run examples/advanced/physics_convex_decomposition/main.py examples/
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/advanced/physics_convex_decomposition/output/0.hdf5
+blenderproc vis hdf5 examples/advanced/physics_convex_decomposition/output/0.hdf5
 ```
 
 ## Implementation

examples/advanced/random_room_constructor/README.md

@@ -30,7 +30,7 @@ Make sure that you have downloaded the `ikea` dataset and the `cctextures` befor
 In the output folder you will find a series of `.hdf5` containers. These can be visualized with the script:
 
 ```
-blenderproc vis_hdf5 examples/advanced/random_room_constructor/output/*.hdf5
+blenderproc vis hdf5 examples/advanced/random_room_constructor/output/*.hdf5
 ``` 
 
 ## Implementation

examples/advanced/stereo_matching/README.md

@@ -24,7 +24,7 @@ blenderproc run examples/advanced/stereo_matching/main.py <path to cam_pose file
 ## Visualizaton
 Visualize the generated data:
 ```
-blenderproc vis_hdf5 examples/advanced/stereo_matching/output/1.hdf5
+blenderproc vis hdf5 examples/advanced/stereo_matching/output/1.hdf5
 ```
 
 ## Implementation

examples/basics/basic/README.md

@@ -27,7 +27,7 @@ The three arguments afterwards are used by the `argparser` at the top of the `ma
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/basics/basic/output/0.hdf5
+blenderproc vis hdf5 examples/basics/basic/output/0.hdf5
 ```
 
 ## Steps

examples/basics/camera_sampling/README.md

@@ -26,7 +26,7 @@ blenderproc run examples/basics/camera_sampling/main.py examples/resources/scene
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/basics/camera_sampling/output/0.hdf5
+blenderproc vis hdf5 examples/basics/camera_sampling/output/0.hdf5
 ```
 
 ## Steps

examples/basics/entity_manipulation/README.md

@@ -23,7 +23,7 @@ blenderproc run examples/basics/entity_manipulation/main.py examples/resources/s
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/basics/entity_manipulation/output/0.hdf5
+blenderproc vis hdf5 examples/basics/entity_manipulation/output/0.hdf5
 ```
 
 ## Steps

examples/basics/light_sampling/README.md

@@ -22,7 +22,7 @@ blenderproc run examples/basics/light_sampling/main.py examples/resources/camera
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/basics/light_sampling/output/0.hdf5
+blenderproc vis hdf5 examples/basics/light_sampling/output/0.hdf5
 ```
 
 ## Steps

examples/basics/material_manipulation/README.md

@@ -26,7 +26,7 @@ blenderproc run examples/basics/material_manipulation/main.py examples/basics/ma
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/basics/material_manipulation/output/0.hdf5
+blenderproc vis hdf5 examples/basics/material_manipulation/output/0.hdf5
 ```
 
 ## Steps

examples/basics/physics_positioning/README.md

@@ -23,7 +23,7 @@ blenderproc run examples/basics/physics_positioning/main.py examples/basics/phys
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/basics/physics_positioning/output/0.hdf5
+blenderproc vis hdf5 examples/basics/physics_positioning/output/0.hdf5
 ```
 
 ## Steps

examples/datasets/amass_human_poses/README.md

@@ -65,7 +65,7 @@ blenderproc run examples/datasets/amass_human_poses/main.py resources/AMASS exam
 In the output folder you will find multiple `.hdf5` files. These can be visualized with the script:
 
 ```shell
-blenderproc vis_hdf5 examples/datasets/amass_human_poses/output/*.hdf5
+blenderproc vis hdf5 examples/datasets/amass_human_poses/output/*.hdf5
 ```
 
 ## Steps

examples/datasets/blenderkit/README.md

@@ -24,7 +24,7 @@ blenderproc run examples/datasets/blenderkit/main.py <PATH_TO_.BLEND_FILE> examp
 In the output folder you will find a series of `.hdf5` containers. These can be visualized with the script:
 
 ```shell
-blenderproc vis_hdf5 examples/datasets/blenderkit/output/*.hdf5
+blenderproc vis hdf5 examples/datasets/blenderkit/output/*.hdf5
 ``` 
 
 ## Steps

examples/datasets/bop_challenge/README.md

@@ -19,7 +19,7 @@ Download the necessary [BOP datasets](https://bop.felk.cvut.cz/datasets/) and th
 Execute in the BlenderProc main directory:
 
 ```
-python scripts/download_cc_textures.py 
+blenderproc download cc_textures 
 ```
 
 ```

examples/datasets/bop_object_on_surface_sampling/README.md

@@ -11,7 +11,7 @@ Make sure that you downloaded the [BOP datasets](https://bop.felk.cvut.cz/datase
 Execute in the BlenderProc main directory:
 
 ```
-python scripts/download_cc_textures.py 
+blenderproc download cc_textures 
 ```
 
 ```

examples/datasets/bop_object_physics_positioning/README.md

@@ -11,7 +11,7 @@ Make sure that you downloaded the [BOP datasets](https://bop.felk.cvut.cz/datase
 Execute in the BlenderProc main directory:
 
 ```
-python scripts/download_cc_textures.py 
+blenderproc download cc_textures 
 ```
 
 ```

examples/datasets/bop_object_pose_sampling/README.md

@@ -25,12 +25,12 @@ blenderproc run examples/datasets/bop_object_pose_sampling/main.py <path_to_bop_
 
 Visualize the generated data and labels:
 ```
-blenderproc vis_hdf5 examples/datasets/bop_object_pose_sampling/output/0.hdf5
+blenderproc vis hdf5 examples/datasets/bop_object_pose_sampling/output/0.hdf5
 ```
 
 Alternatively, since we generated COCO annotations, you can also visualize the generated coco_annotations.json file:
 ```
-blenderproc vis_coco /path/to/output_dir
+blenderproc vis coco /path/to/output_dir
 ``` 
 
 ## Steps

examples/datasets/bop_scene_replication/README.md

@@ -26,7 +26,7 @@ blenderproc run examples/datasets/bop_scene_replication/main.py <path_to_bop_dat
 Visualize the generated data and labels:
 
 ```
-blenderproc vis_hdf5 example/bop_scene_replication/0.hdf5
+blenderproc vis hdf5 example/bop_scene_replication/0.hdf5
 ```
 
 ## Steps

examples/datasets/front_3d/README.md

@@ -53,7 +53,7 @@ blenderproc run examples/datasets/front_3d/main.py {PATH_TO_3D-Front-Json-File}
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/datasets/front_3d/output/0.hdf5
+blenderproc vis hdf5 examples/datasets/front_3d/output/0.hdf5
 ```
 
 ## Steps

examples/datasets/front_3d_with_improved_mat/README.md

@@ -31,7 +31,7 @@ The three arguments afterwards are used to fill placeholders like `<args:0>` ins
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 examples/datasets/front_3d_with_improved_mat/output/0.hdf5
+blenderproc vis hdf5 examples/datasets/front_3d_with_improved_mat/output/0.hdf5
 ```
 
 ## Steps

examples/datasets/haven/README.md

@@ -8,7 +8,7 @@ The focus of this example is the [haven dataset](https://3dmodelhaven.com/) coll
 In order to use this example first download all the haven assets via the haven download script:
 
 ```shell
-python scripts/download_haven.py
+blenderproc download haven
 ```
 
 This will download all 3D models, all environment HDRs and also all textures they provide.
@@ -31,7 +31,7 @@ blenderproc run examples/datasets/haven/main.py resources/haven/models/ArmChair_
 In the output folder you will find a series of `.hdf5` containers. These can be visualized with the script:
 
 ```
-blenderproc vis_hdf5 examples/datasets/haven/output/*.hdf5
+blenderproc vis hdf5 examples/datasets/haven/output/*.hdf5
 ``` 
 
 ## Steps

examples/datasets/ikea/README.md

@@ -35,7 +35,7 @@ blenderproc run examples/datasets/ikea/main.py <PATH_TO_IKEA> examples/datasets/
 In the output folder you will find a series of `.hdf5` containers. These can be visualized with the script:
 
 ```shell
-blenderproc vis_hdf5 examples/datasets/ikea/output/*.hdf5
+blenderproc vis hdf5 examples/datasets/ikea/output/*.hdf5
 ``` 
 
 ## Steps

examples/datasets/pix3d/README.md

@@ -25,7 +25,7 @@ blenderproc run examples/datasets/pix3d/main.py <PATH_TO_Pix3D> examples/dataset
 In the output folder you will find a series of `.hdf5` containers. These can be visualized with the script:
 
 ```
-blenderproc vis_hdf5 examples/datasets/pix3d/output/*.hdf5
+blenderproc vis hdf5 examples/datasets/pix3d/output/*.hdf5
 ``` 
 
 ## Steps

examples/datasets/replica/README.md

@@ -19,7 +19,7 @@ blenderproc run examples/datasets/replica/main.py <path_to_the_replica_data_fold
 Visualize the generated data:
 
 ```
-blenderproc vis_hdf5 example/replica/0.hdf5
+blenderproc vis hdf5 example/replica/0.hdf5
 ```
 
 ## Steps

examples/datasets/scenenet/README.md

@@ -30,7 +30,7 @@ Please remove the `1Office/3_hereisfree_not_labelled.obj` at it is not supported
 In the output folder you will find a series of `.hdf5` containers. These can be visualized with the script:
 
 ```
-blenderproc vis_hdf5 examples/datasets/scenenet/output/*.hdf5
+blenderproc vis hdf5 examples/datasets/scenenet/output/*.hdf5
 ``` 
 
 ## Steps

examples/datasets/scenenet_with_cctextures/README.md

@@ -32,7 +32,7 @@ blenderproc run examples/datasets/scenenet_with_cctextures/main.py <PATH_TO_SCEN
 In the output folder you will find a series of `.hdf5` containers. These can be visualized with the script:
 
 ```
-blenderproc vis_hdf5 examples/datasets/scenenet_with_cctextures/output/*.hdf5
+blenderproc vis hdf5 examples/datasets/scenenet_with_cctextures/output/*.hdf5
 ``` 
 
 ## Steps

examples/datasets/shapenet/README.md

@@ -24,7 +24,7 @@ blenderproc run examples/datasets/shapenet/main.py <PATH_TO_ShapeNetCore.v2> exa
 In the output folder you will find a series of `.hdf5` containers. These can be visualized with the script:
 
 ```
-blenderproc vis_hdf5 examples/datasets/shapenet/output/*.hdf5
+blenderproc vis hdf5 examples/datasets/shapenet/output/*.hdf5
 ``` 
 
 ## Steps

examples/datasets/shapenet_with_scenenet/README.md

@@ -31,7 +31,7 @@ As this example requires a bed to be present in the scene, it will only work wit
 In the output folder you will find a series of `.hdf5` containers. These can be visualized with the script:
 
 ```
-blenderproc vis_hdf5 examples/datasets/shapenet_with_scenenet/output/*.hdf5
+blenderproc vis hdf5 examples/datasets/shapenet_with_scenenet/output/*.hdf5
 ``` 
 
 ## Steps

examples/datasets/shapenet_with_scenenet/main.py

@@ -3,7 +3,7 @@
 import argparse
 
 parser = argparse.ArgumentParser()
-parser.add_argument('scene_net_obj_path', help="Path to the used scene net `.obj` file, download via scripts/download_scenenet.py")
+parser.add_argument('scene_net_obj_path', help="Path to the used scene net `.obj` file, download via 'blenderproc download scenenet'")
 parser.add_argument('scene_texture_path', help="Path to the downloaded texture files, you can find them at http://tinyurl.com/zpc9ppb")
 parser.add_argument('shapenet_path', help="Path to the downloaded shape net core v2 dataset, get it from http://www.shapenet.org/")
 parser.add_argument('output_dir', nargs='?', default="examples/datasets/shapenet_with_scenenet/output", help="Path to where the final files, will be saved")