Function main

The CLI program that defines the input and output parameters, provides explanations, and converts the parameters into the appropriate formats for the headless program. The minimum configuration includes only simulation geometry and irradiance data. Below is a list of all existing CLI parameters.

Required parameters:

• --simulation-geometry: Simulation geometry file(s) or directory. Supports JSON format: { positions: number[] } and OBJ files. Example file in https://github.com/open-pv/simshady/tree/main/tests/headless/data
• --irradiance-data: Solar irradiance JSON file. JSON format: utils.SolarIrradianceData or SolarIrradianceData[]. Example file in https://github.com/open-pv/simshady/tree/main/tests/headless/data

Optional parameters for the calculation:

• --shading-geometry: Shading geometry file(s) or directory. Supports JSON format: { positions: number[] } and OBJ files
• --efficiency: Efficiency of the conversion from solar energy to electricity. Value in [0,1]
• --maximum-yield: Upper boundary of annual yield in kWh/m2/year.This value is used to normalize the color of the returned three.js mesh.

To generate artifacts, at least --output-dir must be used. Parameters that affect the output or artifact generation are:

• --output-dir: The directory where output artifacts should get stored in.
• --summary/--no-summary: Flag indicating if per-time-step and total summaries should get stored. (default: true)
• --snapshot-topdown/--no-snapshot-topdown: Flag indicating if an orthographic top-down snapshot should get stored (default: true)
• --topdown-size: Snapshot size defines as width x height, e.g. "4096x4096" (default: "4096x4096")
• --obj/--no-obj: Flag indicating if a .obj file should get stored (default: true)

Other parameters are:

• --silent: Mute verbose output (default: false)
• --chrome-args: Additional Chrome launch argument(s). They will get applied to the headless browser session before launch.
• --max-old-space-size: Sets the max memory size of V8's old memory section in the browser (in MiB) (default: 16384). It might be necessary to increase the V8’s old memory outside the browser as well.