Skip to content

BH.oM.LadybugTools.SolarRadiationPlotCommand

Command to use in conjunction with the LadybugToolsAdapter, that simulates a range of angles that a PV panel could rest at, and measures the amount of radiation (and by extension the energy that the panels create) at that angle.

Class structure

Implemented interfaces and base types

The SolarRadiationPlotCommand is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
EPWFile FileSettings The EPW file to use for simulation. -
Directions int The number of different azimuthal angles to simulate. -
Tilts int The number of different altitudinal angles to simulate. -
IrradianceType IrradianceType The irradiance type to plot. Total for all. -
AnalysisPeriod AnalysisPeriod The analysis period to simulate/plot. -
ColourMap string A Matplotlib colour map. Corresponds to the 'cmap' parameter of plot methods. See https://matplotlib.org/stable/users/explain/colors/colormaps.html for examples of valid keys. Default of 'YlOrRd'. -
Title string The title of the plot. Will appear above any information at the top of the plot. -
OutputLocation string The location to place any images generated by the command. Leave empty to return a base64 string representation of the image. -

Code and Schema

C# implementation

C#
public class SolarRadiationPlotCommand : BH.oM.LadybugTools.ISimulationCommand, BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject

Assembly: LadybugTools_oM.dll

The C# class definition is available on github:

All history and changes of the class can be found by inspection the history.

JSON Schema implementation

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema
{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/LadybugTools_oM/SolarRadiationPlotCommand.json"
}

The JSON Schema is available on github here: