Skip to content
Snippets Groups Projects
Commit fc1b6eec authored by Giovanni La Mura's avatar Giovanni La Mura
Browse files

Fix model_maker inline documentation

parent 25477404
No related branches found
No related tags found
No related merge requests found
...@@ -31,6 +31,7 @@ import pdb ...@@ -31,6 +31,7 @@ import pdb
import random import random
import yaml import yaml
## \brief 3D software generation capability flag.
allow_3d = True allow_3d = True
try: try:
import pyvista as pv import pyvista as pv
...@@ -46,7 +47,7 @@ from sys import argv ...@@ -46,7 +47,7 @@ from sys import argv
# `main()` is the function that handles the creation of the code configuration. # `main()` is the function that handles the creation of the code configuration.
# It returns an integer value as exit code, using 0 to signal successful execution. # It returns an integer value as exit code, using 0 to signal successful execution.
# #
# \returns result: `int` Number of detected error-level inconsistencies. # \returns result: `int` Exit code (0 = SUCCESS).
def main(): def main():
result = 0 result = 0
config = parse_arguments() config = parse_arguments()
...@@ -952,9 +953,10 @@ def write_legacy_sconf(conf): ...@@ -952,9 +953,10 @@ def write_legacy_sconf(conf):
## \brief Export the model to a set of OBJ files for 3D visualization. ## \brief Export the model to a set of OBJ files for 3D visualization.
# #
# This function exports the model as a set of OBJ files (one for every # This function exports the model as a single OBJ file, containing the
# spherical unit, plus a single scene file) to allow for model visualization # information to visualize the particle with 3D software tools. The model
# with 3D software tools. # file is associated with a MTL material libray file, used to assign colors
# to spheres of different type.
# #
# \param scatterer: `dict` Scatterer configuration dictionary (gets modified) # \param scatterer: `dict` Scatterer configuration dictionary (gets modified)
# \param geometry: `dict` Geometry configuration dictionary (gets modified) # \param geometry: `dict` Geometry configuration dictionary (gets modified)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment