Advanced features
Follow this page for information regarding advanced features.
CLI Command Reference
Marso supports a Command Line Interface (CLI) for use in programmatic workflows where a GUI would be undesirable. The command structure follows most of the flow of the GUI, the only major functionality that is not included is the queue system as this is left to the user to handle through looping over the commands as they see fit.
N.B. Marso has startup time around ~10 seconds so it is normal for commands that have no processing to take some time to return. All commands are blocking and will return an exitcode.
All commands follow this structure:
Sub-command: User
There are three subcommands for user:
Used to login through the account and activate the machine
Sub-command: System
There are two subcommands for system:
Allows for the configuration of the Marso application settings.
Possible arguments:
Specifies the path for Marso to use as its scratch directory while running:
Specifies the path for Marso to output the PBR textures to
Toggles whether Marso will delete the cache files for job from the scratch directory upon completion. By default Marso will delete the files.
Sub-command: Job
There are N subcommands for job:
This command is used to create the job with these two required arguments:
There are then three optional args that can be appended to the above command:
This changes the mode of the job, by default it is set to 3D.
This will immediately activate the newly created job so it is ready for the next step in the workflow
This lets you input the light system and immediately attach it to the job, from an input CSV file with the heading columns X,Y,Z
Sub-command: Lights
This must be run with a currently activated job.
This lets you input the light system from an input CSV file with the heading columns X,Y,Z. Each row is then a light in the given light configuration used.
Sub-command: Exposure
This must be run with a currently activated job.
There is an optional argument which can be added to the above command, to not use the GUI and instead use 4 markers to detect the rectangle on the grey card:
If you wish to generate the markers then this can only be done through the exposure parameters section of the GUI.
Sub-command: Develop
This must be run with a currently activated job.
This command runs the develop process which produces the images for a job to be used in the reconstruction tool of your choice. You can choose between different filetypes by using one of the arguments in the [--jpeg,--exr].
Sub-command: Process
This must be run with a currently activate job.
This commands starts the main processing operation of Marso on the currently activated job. Arguments that have multiple options you need to pick from are denoted by [,]. There are some optional arguments that can be appended to the command aswell:
This argument lets you specify a mesh mask.
By default the final output textures have a bleed applied to reduce the impact of seams when placed back on the mesh. This option disable the application of the bleed.
Sub-command: Shaders
This command must be run with the currently activated job.
This will print out the avaialable shaders that can be used in the process subcommand.
Sub-command: Status
This command will print the global status of Marso including the user, the configuratona and the job information
Sub-command: Update
This command will run the updater to check if there is an update and then proceed to update the currently installed version of Marso.
Example command sequence for a run through
Disabling splash screen
During the startup phase for Marso a splash screen is presented while it loads. This can be incovenient for some people, especially when using the CLI.
To disable set this environment variable PYINSTALLER_RESET_ENVIRONMENT=1 .
Last updated
