CreateSimulationRequest

Basic Asynchronous Request

Method: POST
URL: https://service.solaranywhere.com/api/v2/Simulation

Use the example simulation requests below to make requests for irradiance, weather, energy, and power output data using an EnergySiteId. EnergySiteIds are returned in the EnergySiteCreateResponse returned after submitting an EnergySiteCreateRequest.

Clean Power Research offers two simulation models for use as the PowerModel in your simulation requests: pvlib and CprPVForm. The XML simulation request samples below are divided by model. Visit the introduction page to learn more about the simulation models and decide which is better suited to your needs.

Create a Simulation Request Using the pvlib Power Model

If you plan to use the pvlib power model, use these samples to get started.

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "PvLib",
    "SnowLossModel": "None",
    "SoilingLossModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "PowerDC_kW",
      "PowerBeforeGridInterconnectionLimitAC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "DataVersion",
      "AmbientTemperature_DegreesC",
      "AmbientTemperatureObservationType",
      "WindSpeed_MetersPerSecond",
      "WindSpeedObservationType",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "ClearSkyPowerAC_kW",
      "ClearSkyEnergyAC_kWh",
      "RelativeHumidity_Percent",
      "SnowDepth_Meters",
      "LiquidPrecipitation_KilogramsPerMeterSquared",
      "SolidPrecipitation_KilogramsPerMeterSquared",
      "Albedo_Unitless"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-02-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "PvLib",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "PowerDC_kW",
      "EnergyAC_kWh",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "AmbientTemperature_DegreesC"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2022-01-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereHindcast",
      "ForecastHorizon_Hours": 24
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "PvLib",
    "SnowLossModel": "None",
    "SoilingLossModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "PowerDC_kW",
      "PowerBeforeGridInterconnectionLimitAC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "DataVersion",
      "AmbientTemperature_DegreesC",
      "AmbientTemperatureObservationType",
      "WindSpeed_MetersPerSecond",
      "WindSpeedObservationType",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "ClearSkyPowerAC_kW",
      "ClearSkyEnergyAC_kWh",
      "RelativeHumidity_Percent",
      "SnowDepth_Meters",
      "LiquidPrecipitation_KilogramsPerMeterSquared",
      "SolidPrecipitation_KilogramsPerMeterSquared",
      "Albedo_Unitless"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.005,
      "TimeResolution_Minutes": 5,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-02-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit",
      "ApplyTrueDynamics": true
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "PvLib",
    "SnowLossModel": "None",
    "SoilingLossModel": "HSU",
    "BifacialModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "PowerDC_kW",
      "PowerBeforeGridInterconnectionLimitAC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "DataVersion",
      "AmbientTemperature_DegreesC",
      "AmbientTemperatureObservationType",
      "WindSpeed_MetersPerSecond",
      "WindSpeedObservationType",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "ClearSkyPowerAC_kW",
      "ClearSkyEnergyAC_kWh",
      "RelativeHumidity_Percent",
      "SnowDepth_Meters",
      "LiquidPrecipitation_KilogramsPerMeterSquared",
      "SolidPrecipitation_KilogramsPerMeterSquared",
      "Albedo_Unitless",
      "ParticulateMatter2_5_MicrogramsPerMeterCubed",
      "ParticulateMatter10_MicrogramsPerMeterCubed",
      "SoilingLossesDC_kW",
      "SoilingLossesDC_Percent"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-02-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "PvLib",
    "SnowLossModel": "None",
    "SoilingLossModel": "Kimber",
    "BifacialModel":"None",
    "InitialSoiling": 0,
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "PowerDC_kW",
      "PowerBeforeGridInterconnectionLimitAC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "DataVersion",
      "AmbientTemperature_DegreesC",
      "AmbientTemperatureObservationType",
      "WindSpeed_MetersPerSecond",
      "WindSpeedObservationType",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "ClearSkyPowerAC_kW",
      "ClearSkyEnergyAC_kWh",
      "RelativeHumidity_Percent",
      "SnowDepth_Meters",
      "LiquidPrecipitation_KilogramsPerMeterSquared",
      "SolidPrecipitation_KilogramsPerMeterSquared",
      "Albedo_Unitless",
      "ParticulateMatter2_5_MicrogramsPerMeterCubed",
      "ParticulateMatter10_MicrogramsPerMeterCubed",
      "SoilingLossesDC_kW",
      "SoilingLossesDC_Percent"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-02-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "PvLib",
    "SnowLossModel": "NREL",
    "SoilingLossModel": "None",
    "BifacialModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "PowerDC_kW",
      "PowerBeforeGridInterconnectionLimitAC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "DataVersion",
      "AmbientTemperature_DegreesC",
      "AmbientTemperatureObservationType",
      "WindSpeed_MetersPerSecond",
      "WindSpeedObservationType",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "ClearSkyPowerAC_kW",
      "ClearSkyEnergyAC_kWh",
      "RelativeHumidity_Percent",
      "SnowDepth_Meters",
      "LiquidPrecipitation_KilogramsPerMeterSquared",
      "SolidPrecipitation_KilogramsPerMeterSquared",
      "Albedo_Unitless",
      "SnowLossesDC_kW",
      "SnowLossesDC_Percent"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-02-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "PvLib",
    "SnowLossModel": "Townsend",
    "SoilingLossModel": "None",
    "BifacialModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "PowerDC_kW",
      "PowerBeforeGridInterconnectionLimitAC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "DataVersion",
      "AmbientTemperature_DegreesC",
      "AmbientTemperatureObservationType",
      "WindSpeed_MetersPerSecond",
      "WindSpeedObservationType",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "ClearSkyPowerAC_kW",
      "ClearSkyEnergyAC_kWh",
      "RelativeHumidity_Percent",
      "SnowDepth_Meters",
      "LiquidPrecipitation_KilogramsPerMeterSquared",
      "SolidPrecipitation_KilogramsPerMeterSquared",
      "Albedo_Unitless",
      "SnowLossesDC_kW",
      "SnowLossesDC_Percent"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-02-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "PvLib",
    "SnowLossModel": "None",
    "SoilingLossModel": "HSU",
    "ShadingModel": "MonthlyPercentSolarResource",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "PowerDC_kW",
      "PowerBeforeGridInterconnectionLimitAC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "DataVersion",
      "AmbientTemperature_DegreesC",
      "AmbientTemperatureObservationType",
      "WindSpeed_MetersPerSecond",
      "WindSpeedObservationType",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "ClearSkyPowerAC_kW",
      "ClearSkyEnergyAC_kWh",
      "RelativeHumidity_Percent",
      "SnowDepth_Meters",
      "LiquidPrecipitation_KilogramsPerMeterSquared",
      "SolidPrecipitation_KilogramsPerMeterSquared",
      "Albedo_Unitless",
      "ParticulateMatter2_5_MicrogramsPerMeterCubed",
      "ParticulateMatter10_MicrogramsPerMeterCubed",
      "SoilingLossesDC_kW",
      "SoilingLossesDC_Percent"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-02-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

{ 
  "EnergySites": [ 
    { 
      "EnergySiteId": "D7RCV0GWVQ" 
    } 
  ], 
  "SimulationOptions": { 
    "PowerModel": "PvLib", 
    "SnowLossModel": "NREL", 
    "SoilingLossModel": "HSU", 
    "BifacialModel":"InfiniteSheds", 
    "OutputFields": [ 
      "StartTime", 
      "EndTime", 
      "PowerAC_kW", 
      "PowerDC_kW", 
      "PowerBeforeGridInterconnectionLimitAC_kW", 
      "EnergyAC_kWh", 
      "GlobalHorizontalIrradiance_WattsPerMeterSquared", 
      "DirectNormalIrradiance_WattsPerMeterSquared", 
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared", 
      "IrradianceObservationType", 
      "DataVersion", 
      "AmbientTemperature_DegreesC", 
      "AmbientTemperatureObservationType", 
      "WindSpeed_MetersPerSecond", 
      "WindSpeedObservationType", 
      "PlaneOfArrayIrradiance_WattsPerMeterSquared", 
      "ClearSkyPowerAC_kW", 
      "ClearSkyEnergyAC_kWh", 
      "RelativeHumidity_Percent", 
      "SnowDepth_Meters", 
      "LiquidPrecipitation_KilogramsPerMeterSquared", 
      "SolidPrecipitation_KilogramsPerMeterSquared", 
      "Albedo_Unitless", 
      "ParticulateMatter2_5_MicrogramsPerMeterCubed",
      "ParticulateMatter10_MicrogramsPerMeterCubed", 
      "PlaneOfArrayIrradiance_WattsPerMeterSquared", 
      "PlaneOfArrayIrradianceBackSurface_WattsPerMeterSquared",
      "PlaneOfArrayIrradianceFrontSurface_WattsPerMeterSquared" 
  ], 
    "WeatherDataOptions": { 
      "SpatialResolution_Degrees": 0.01, 
      "TimeResolution_Minutes": 60, 
      "StartTime": "2020-01-01T00:00:00-08:00", 
      "EndTime": "2020-02-01T00:00:00-08:00", 
      "WeatherDataSource": "SolarAnywhereLatest", 
      "MissingDataHandling": "Omit" 
    } 
  } 
}

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="D7RCV0GWVQ"> </EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib" 
  SnowLossModel="None"
  SoilingLossModel="None"
  OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,PowerBeforeGridInterconnectionLimitAC_kW,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,
  DirectNormalIrradiance_WattsPerMeterSquared,DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,DataVersion,
  AmbientTemperature_DegreesC,AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,
  PlaneOfArrayIrradiance_WattsPerMeterSquared,ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,
  LiquidPrecipitation_KilogramsPerMeterSquared,SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="9ZHR91V36F"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib"
OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,PlaneOfArrayIrradiance_WattsPerMeterSquared,EnergyAC_kWh,
GlobalHorizontalIrradiance_WattsPerMeterSquared,DirectNormalIrradiance_WattsPerMeterSquared,
DiffuseHorizontalIrradiance_WattsPerMeterSquared,AmbientTemperature_DegreesC">
<WeatherDataOptions
WeatherDataSource="SolarAnywhereHindcast"
StartTime="2020-01-01T00:00:00-08:00"
EndTime="2022-01-01T00:00:00-08:00"
SpatialResolution_Degrees="0.01"
TimeResolution_Minutes="60"
ForecastHorizon_Hours= "24"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="D7RCV0GWVQ"> </EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib" 
  SnowLossModel="None"
  SoilingLossModel="None"
  OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,PowerBeforeGridInterconnectionLimitAC_kW,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,
  DirectNormalIrradiance_WattsPerMeterSquared,DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,DataVersion,
  AmbientTemperature_DegreesC,AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,
  PlaneOfArrayIrradiance_WattsPerMeterSquared,ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,
  LiquidPrecipitation_KilogramsPerMeterSquared,SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.005"
    TimeResolution_Minutes="5"
    ApplyTrueDynamics="true"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="D7RCV0GWVQ"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib"
  SnowLossModel="None"
  SoilingLossModel="HSU"
  BifacialModel="None"
  OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,PowerBeforeGridInterconnectionLimitAC_kW,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,
  DirectNormalIrradiance_WattsPerMeterSquared,DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,DataVersion,AmbientTemperature_DegreesC,
  AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,PlaneOfArrayIrradiance_WattsPerMeterSquared,
  ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,LiquidPrecipitation_KilogramsPerMeterSquared,
  SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless,ParticulateMatter2.5_MicrogramsPerMeterCubed,ParticulateMatter10_MicrogramsPerMeterCubed,SoilingLossesDC_kW,SoilingLossesDC_Percent">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="D7RCV0GWVQ"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib"
  SnowLossModel="None"
  SoilingLossModel="Kimber"
  BifacialModel = "None"
  InitialSoiling = "0"
  OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,PowerBeforeGridInterconnectionLimitAC_kW,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,
  DirectNormalIrradiance_WattsPerMeterSquared,DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,DataVersion,AmbientTemperature_DegreesC,
  AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,PlaneOfArrayIrradiance_WattsPerMeterSquared,
  ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,LiquidPrecipitation_KilogramsPerMeterSquared,
  SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless,ParticulateMatter2.5_MicrogramsPerMeterCubed,ParticulateMatter10_MicrogramsPerMeterCubed,SoilingLossesDC_kW,SoilingLossesDC_Percent">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="D7RCV0GWVQ"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib"
  SnowLossModel="NREL"
  SoilingLossModel="None"
  BifacialModel="None"
  OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,PowerBeforeGridInterconnectionLimitAC_kW,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,
  DirectNormalIrradiance_WattsPerMeterSquared,DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,DataVersion,AmbientTemperature_DegreesC,
  AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,PlaneOfArrayIrradiance_WattsPerMeterSquared,
  ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,LiquidPrecipitation_KilogramsPerMeterSquared,
  SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless,SnowLossesDC_kW,SnowLossesDC_Percent">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="D7RCV0GWVQ"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib"
  SnowLossModel="Townsend"
  SoilingLossModel="None"
  BifacialModel="None"
  OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,PowerBeforeGridInterconnectionLimitAC_kW,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,
  DirectNormalIrradiance_WattsPerMeterSquared,DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,DataVersion,AmbientTemperature_DegreesC,
  AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,PlaneOfArrayIrradiance_WattsPerMeterSquared,
  ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,LiquidPrecipitation_KilogramsPerMeterSquared,
  SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless,SnowLossesDC_kW,SnowLossesDC_Percent">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="D7RCV0GWVQ"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib"
  SnowLossModel="None"
  SoilingLossModel="HSU"
  ShadingModel="MonthlyPercentSolarResource"
  OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,PowerBeforeGridInterconnectionLimitAC_kW,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,
  DirectNormalIrradiance_WattsPerMeterSquared,DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,DataVersion,AmbientTemperature_DegreesC,
  AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,PlaneOfArrayIrradiance_WattsPerMeterSquared,
  ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,LiquidPrecipitation_KilogramsPerMeterSquared,
  SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless,ParticulateMatter2.5_MicrogramsPerMeterCubed,ParticulateMatter10_MicrogramsPerMeterCubed,SoilingLossesDC_kW,SoilingLossesDC_Percent">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="D7RCV0GWVQ"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib"
  SnowLossModel="NREL"
  SoilingLossModel="HSU"
  BifacialModel="InfiniteSheds"
  OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,PowerBeforeGridInterconnectionLimitAC_kW,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,
  DirectNormalIrradiance_WattsPerMeterSquared,DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,DataVersion,AmbientTemperature_DegreesC,
  AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,PlaneOfArrayIrradiance_WattsPerMeterSquared,
  ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,LiquidPrecipitation_KilogramsPerMeterSquared,
  SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless,ParticulateMatter2.5_MicrogramsPerMeterCubed,ParticulateMatter10_MicrogramsPerMeterCubed,PlaneOfArrayIrradiance_WattsPerMeterSquared,PlaneOfArrayIrradianceBackSurface_WattsPerMeterSquared,PlaneOfArrayIrradianceFrontSurface_WattsPerMeterSquared">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

Snow Loss Modeling
The pvlib power model allows you to model snow losses using Bill Marion’s snow loss model or the Townsend snow loss model. pvlib leverages SolarAnywhere snow depth and ambient temperature data to calculate site-specific snow loss estimates. Because snow loss calculations are based on accumulated snow, the snow loss model will consider snow depth and ambient temperature data for 6 months prior to the StartTime specified in the request. Visit our Terms & Concepts page to learn more about this snow loss model.

In order to model snow losses, specify NREL or Townsend as the SnowLossModel in the SimulationOptions and include the following in the OutputFields list of your simulation request: SnowLossesDC_kW,SnowLossesDC_Percent . If you do not want to model snow losses, specify None or remove it from the request completely.

Snow loss output fields can only be specified when requesting historical or real-time time series data. Real-time time series requests for snow loss output fields outside the Continental United States are limited to the trailing week rather than the current hour. These fields cannot be specified when requesting a typical year or average year WeatherDataSource or when requesting forecasted time series data.

Soiling Loss Modeling
The pvlib power model allows you to model soiling losses using the Humboldt State University soiling model or the Kimber soiling model.

The HSU soiling model leverages SolarAnywhere precipitation and particulate matter data to calculate site-specific soiling loss estimates. These soiling loss calculations are based on accumulated dirt, and such the soiling loss model will consider precipitation and particulate matter data for 6 months prior to the StartTime specified in the request.
The Kimber model assumes daily soiling accumulation at a defined rate. An InitialSoiling value can be defined in the SimulationOptions as a fraction of energy lost due to soiling at the beginning of the simulation.

In order to model soiling losses, specify HSU or Kimber as the SoilingLossModel in the SimulationOptions, and include the following in the OutputFields list of your simulation request: SoilingLossesDC_kW,SoilingLossesDC_Percent. If you do not want to model soiling losses, specify None or remove it from the request completely.

Soiling loss output fields can only be specified when requesting historical time-series data. These fields cannot be specified when requesting a typical-year or average-year WeatherDataSource, or when requesting forecasted time series data. Visit the the Terms & Concepts page to learn more about this soiling loss model.

Shading Loss Modeling
SolarAnywhere supports the use of the MonthlyPercentSolarResource shading model when using the pvlib power model. In order to model monthly shading losses, specify monthly solar access percentages when creating your energy site, then specify MonthlyPercentSolarResource as the ShadingModel in the SimulationOptions. If you do not want to model shading losses, specify None or remove it from the request completely. Visit the Terms & Concepts page to learn more about the MonthlyPercentSolarResource shading model.

Bifacial PV System Modeling
SolarAnywhere supports the use of the Infinite Sheds bifacial model when using the pvlib power model. In order to model a bifacial PV system, specify Bifacial = “true” when creating your energy site, then specify InfiniteSheds as the BifacialModel in the SimulationOptions.  If your PV system has monofacial PV modules, specify BifacialModel as None or remove it from the request completely.

For PV systems that are bifacial, users can access the front and back surface Plane of Array Irradiance (POAI) separately by specifying PlaneOfArrayIrradianceBackSurface_WattsPerMeterSquared and PlaneOfArrayIrradianceFrontSurface_WattsPerMeterSquared respectively in the OutputFields under SimulationOptions. The total POAI for each time step can be accessed using the PlaneOfArrayIrradiance_WattsPerMeterSquared output field and is calculated as the sum of the front and back surface Plane of Array Irradiance for the specific time step.

Visit the Terms & Concepts page page to learn more about the Infinite Sheds bifacial model.

Create a Simulation Request Using the CprPVForm Power Model

If you plan to use the CprPVForm power model, use these XML samples to get started.

{
  "EnergySites": [
    {
      "EnergySiteId": "NZ3RTPHLJE"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "CprPVForm",
    "ShadingModel": "Default",
    "SnowLossModel": "None",
    "SoilingLossModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "AmbientTemperature_DegreesC",
      "AmbientTemperatureObservationType",
      "WindSpeed_MetersPerSecond",
      "WindSpeedObservationType",
      "DataVersion",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "CapacitySimulatedDC_Percent",
      "CapacitySimulatedDC_kW",
      "ClearSkyPowerAC_kW",
      "ClearSkyEnergyAC_kWh",
      "RelativeHumidity_Percent",
      "SnowDepth_Meters",
      "LiquidPrecipitation_KilogramsPerMeterSquared",
      "SolidPrecipitation_KilogramsPerMeterSquared",
      "Albedo_Unitless"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.1,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-02-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "CprPVForm",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "PowerDC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "AmbientTemperature_DegreesC",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2022-01-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereHindcast",
      "ForecastHorizon_Hours": 24
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "NZ3RTPHLJE"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "CprPVForm",
    "ShadingModel": "Default",
    "SnowLossModel": "None",
    "SoilingLossModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "AmbientTemperature_DegreesC",
      "AmbientTemperatureObservationType",
      "WindSpeed_MetersPerSecond",
      "WindSpeedObservationType",
      "DataVersion",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "CapacitySimulatedDC_Percent",
      "CapacitySimulatedDC_kW",
      "ClearSkyPowerAC_kW",
      "ClearSkyEnergyAC_kWh",
      "RelativeHumidity_Percent",
      "SnowDepth_Meters",
      "LiquidPrecipitation_KilogramsPerMeterSquared",
      "SolidPrecipitation_KilogramsPerMeterSquared",
      "Albedo_Unitless"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.005,
      "TimeResolution_Minutes": 5,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-02-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit",
      "ApplyTrueDynamics": true
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "NZ3RTPHLJE"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "CprPVForm",
    "ShadingModel": "ShadeSimulator",
    "SnowLossModel": "None",
    "SoilingLossModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "AmbientTemperature_DegreesC",
      "AmbientTemperatureObservationType",
      "WindSpeed_MetersPerSecond",
      "WindSpeedObservationType",
      "DataVersion",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "CapacitySimulatedDC_Percent",
      "CapacitySimulatedDC_kW",
      "ClearSkyPowerAC_kW",
      "ClearSkyEnergyAC_kWh",
      "RelativeHumidity_Percent",
      "SnowDepth_Meters",
      "LiquidPrecipitation_KilogramsPerMeterSquared",
      "SolidPrecipitation_KilogramsPerMeterSquared",
      "Albedo_Unitless"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-02-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "NZ3RTPHLJE"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "CprPVForm",
    "ShadingModel": "MonthlyPercentSolarResource",
    "SnowLossModel": "None",
    "SoilingLossModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "DiffuseHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "AmbientTemperature_DegreesC",
      "AmbientTemperatureObservationType",
      "WindSpeed_MetersPerSecond",
      "WindSpeedObservationType",
      "DataVersion",
      "PlaneOfArrayIrradiance_WattsPerMeterSquared",
      "CapacitySimulatedDC_Percent",
      "CapacitySimulatedDC_kW",
      "ClearSkyPowerAC_kW",
      "ClearSkyEnergyAC_kWh",
      "RelativeHumidity_Percent",
      "SnowDepth_Meters",
      "LiquidPrecipitation_KilogramsPerMeterSquared",
      "SolidPrecipitation_KilogramsPerMeterSquared",
      "Albedo_Unitless"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-02-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="NZ3RTPHLJE"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="CprPVForm"
  OutputFields="StartTime,EndTime,PowerAC_kW,
    EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,DirectNormalIrradiance_WattsPerMeterSquared,
    DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,AmbientTemperature_DegreesC,
    AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,DataVersion,
    PlaneOfArrayIrradiance_WattsPerMeterSquared,CapacitySimulatedDC_Percent,CapacitySimulatedDC_kW,
    ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,LiquidPrecipitation_KilogramsPerMeterSquared,
    SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.1"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="9ZHR91V36F"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="CprPVForm"
OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,EnergyAC_kWh,
GlobalHorizontalIrradiance_WattsPerMeterSquared,DirectNormalIrradiance_WattsPerMeterSquared,
DiffuseHorizontalIrradiance_WattsPerMeterSquared,AmbientTemperature_DegreesC,
PlaneOfArrayIrradiance_WattsPerMeterSquared">
<WeatherDataOptions
WeatherDataSource="SolarAnywhereHindcast"
StartTime="2020-01-01T00:00:00-08:00"
EndTime="2022-01-01T00:00:00-08:00"
SpatialResolution_Degrees="0.01"
TimeResolution_Minutes="60"
ForecastHorizon_Hours= "24"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="NZ3RTPHLJE"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="CprPVForm"
  OutputFields="StartTime,EndTime,PowerAC_kW,
    EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,DirectNormalIrradiance_WattsPerMeterSquared,
    DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,AmbientTemperature_DegreesC,
    AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,DataVersion,
    PlaneOfArrayIrradiance_WattsPerMeterSquared,CapacitySimulatedDC_Percent,CapacitySimulatedDC_kW,
    ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,LiquidPrecipitation_KilogramsPerMeterSquared,
    SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.005"
    TimeResolution_Minutes="5"
    ApplyTrueDynamics="true"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="NZ3RTPHLJE"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="CprPVForm"
  ShadingModel="ShadeSimulator" 
  OutputFields="StartTime,EndTime,PowerAC_kW,
    EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,DirectNormalIrradiance_WattsPerMeterSquared,
    DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,AmbientTemperature_DegreesC,
    AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,DataVersion,
    PlaneOfArrayIrradiance_WattsPerMeterSquared,CapacitySimulatedDC_Percent,CapacitySimulatedDC_kW,
    ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,LiquidPrecipitation_KilogramsPerMeterSquared,
    SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="NZ3RTPHLJE"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="CprPVForm"
  ShadingModel="MonthlyPercentSolarResource" 
  OutputFields="StartTime,EndTime,PowerAC_kW,
    EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,DirectNormalIrradiance_WattsPerMeterSquared,
    DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,AmbientTemperature_DegreesC,
    AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,DataVersion,
    PlaneOfArrayIrradiance_WattsPerMeterSquared,CapacitySimulatedDC_Percent,CapacitySimulatedDC_kW,
    ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,LiquidPrecipitation_KilogramsPerMeterSquared,
    SolidPrecipitation_KilogramsPerMeterSquared,Albedo_Unitless">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-02-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

Shading Models

There are two shading models you can specify when using the CprPVForm power model. You will need to specify the shading model corresponding to the way shading was defined in the EnergySiteCreateRequest. Visit the Terms & Concepts page to learn more about these shading models.

ShadeSimulator
MonthlyPercentSolarResource

Output Field Options

This the the list of output fields and summary output that can be requested. The list include both irradiance and weather data outputs and simulation outputs. For more information, see Irradiance and Weather Data – Options or Solar Simulations – Terms and Concepts.

Irradiance and Weather Data Output Fields:

StartTime
ObservationTime
EndTime
GlobalHorizontalIrradiance_WattsPerMeterSquared
DirectNormalIrradiance_WattsPerMeterSquared
DiffuseHorizontalIrradiance_WattsPerMeterSquared
IrradianceObservationType
AmbientTemperature_DegreesC
AmbientTemperatureObservationType
WindSpeed_MetersPerSecond
WindSpeedObservationType
DataVersion
ForecastLeadTime_Minutes
RelativeHumidity_Percent
SnowDepth_Meters ²
LiquidPrecipitation_KilogramsPerMeterSquared ²
SolidPrecipitation_KilogramsPerMeterSquared ²
SolarZenithAngle_Degrees
SolarAzimuthAngle_Degrees
Albedo_Unitless ¹
ParticulateMatter2.5_MicrogramsPerMeterCubed ¹
ParticulateMatter10_MicrogramsPerMeterCubed ¹

Simulation Output Fields:

PowerAC_kW
PowerDC_kW
EnergyAC_kWh
PowerBeforeGridInterconnectionLimitAC_kW
ClearSkyPowerBeforeGridInterconnectionLimitAC_kW
PlaneOfArrayIrradiance_WattsPerMeterSquared
PlaneOfArrayIrradianceBackSurface_WattsPerMeterSquared ⁵
PlaneOfArrayIrradianceFrontSurface_WattsPerMeterSquared ⁵
PVModuleTemperature_DegreesC
ClearSkyPowerAC_kW
ClearSkyEnergyAC_kWh
SnowLossesDC_kW ^{2, 3}
SnowLossesDC_Percent ^{2, 3}
SoilingLossesDC_kW ^{1, 2, 4}
SoilingLossesDC_Percent ^{1, 2, 4}

Irradiance and Weather Data Summary Output Fields:

TotalGlobalHorizontalIrradiance
TotalDirectNormalIrradiance
TotalLiquidPrecipitation ²
TotalSolidPrecipitation ²
AverageSnowDepth ²
AverageWindSpeed
AverageAmbientTemperature
AverageAlbedo ¹
AveragePm2.5 ¹
AveragePm10 ¹

Simulation Summary Output Fields:

TotalEnergy
TotalSnowLosses ^{2, 3}
AveragePercentSnowLosses ^{2, 3}
TotalSoilingLosses ^{1, 2, 4}
AveragePercentSoilingLosses ^{1, 2, 4}

¹ Not available for forecasted time periods.
² Not available in requests for typical year WeatherDataSources.
³Field can only be requested when you have specified PvLib as the PowerModel and NREL or Townsend as the SnowLossModel, and you are requesting historical or real-time time series data. Real-time time series requests for this field outside the Continental United States are limited to the trailing week rather than the current hour.
⁴Field can only be requested when you have specified PvLib as the PowerModel and HSU or Kimberas theSoilingLossModel, and you are requesting historical or real-time time series data. Real-time time series requests for this field outside the Continental United States are limited to the trailing week rather than the current hour.
⁵These output fields can only be requested when you have specified PvLib as the PowerModel and InfiniteSheds as the BifacialModel

Weather Data Options

WeatherDataOptions attributes specify the source of weather data used in the Simulation request. For more detailed information, see Irradiance and Weather Data Options. The specific WeatherDataSource selected is license and application dependent. Visit our support center to learn more about our time series, typical year, high resolution and hindcast data sources.

Simulation Requests with Summary Output Fields

Below are some additional example simulation requests that include summary output fields. Summary output fields will request results aggregated by month and year. These can be requested alongside time series, typical year, or average year data.

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "PvLib",
    "SnowLossModel": "NREL",
    "SoilingLossModel": "HSU",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DataVersion",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "AmbientTemperature_DegreesC",
      "WindSpeed_MetersPerSecond",
      "SnowDepth_Meters",
      "Albedo_Unitless",
      "SnowLossesDC_kW",
      "SnowLossesDC_Percent",
      "SoilingLossesDC_kW",
      "SoilingLossesDC_Percent"
    ],
    "SummaryOutputFields": [
      "TotalEnergy",
      "TotalGlobalHorizontalIrradiance",
      "TotalDirectNormalIrradiance",
      "AverageWindSpeed",
      "AverageAmbientTemperature",
      "AverageSnowDepth",
      "AverageAlbedo",
      "TotalSnowLosses",
      "AveragePercentSnowLosses",
      "TotalSoilingLosses",
      "AveragePercentSoilingLosses"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2021-01-01T00:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "PvLib",
    "SnowLossModel": "None",
    "SoilingLossModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "DataVersion",
      "DirectNormalIrradiance_WattsPerMeterSquared",
      "AmbientTemperature_DegreesC",
      "WindSpeed_MetersPerSecond",
      "Albedo_Unitless"
    ],
    "SummaryOutputFields": [
      "TotalEnergy",
      "TotalGlobalHorizontalIrradiance",
      "TotalDirectNormalIrradiance",
      "AverageWindSpeed",
      "AverageAmbientTemperature",
      "AverageAlbedo"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "WeatherDataSource": "SolarAnywhereTGYLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="D7RCV0GWVQ"> </EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib"
  SnowLossModel="NREL"
  SoilingLossModel="HSU"
  OutputFields="StartTime,EndTime,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,DataVersion,
  DirectNormalIrradiance_WattsPerMeterSquared,AmbientTemperature_DegreesC,WindSpeed_MetersPerSecond,SnowDepth_Meters,
  Albedo_Unitless,SnowLossesDC_kW,SnowLossesDC_Percent,SoilingLossesDC_kW,SoilingLossesDC_Percent"
  SummaryOutputFields="TotalEnergy,TotalGlobalHorizontalIrradiance,TotalDirectNormalIrradiance,AverageWindSpeed,
  AverageAmbientTemperature,AverageSnowDepth,AverageAlbedo,TotalSnowLosses,AveragePercentSnowLosses,TotalSoilingLosses,AveragePercentSoilingLosses">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2021-01-01T00:00:00-08:00"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="D7RCV0GWVQ"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib"
  SnowLossModel="None"
  SoilingLossModel="None"
  OutputFields="StartTime,EndTime,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,DataVersion,
  DirectNormalIrradiance_WattsPerMeterSquared,AmbientTemperature_DegreesC,WindSpeed_MetersPerSecond,Albedo_Unitless"
  SummaryOutputFields="TotalEnergy,TotalGlobalHorizontalIrradiance,TotalDirectNormalIrradiance,AverageWindSpeed,
  AverageAmbientTemperature,AverageAlbedo">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereTGYLatest"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

Bulk Simulation Requests

Below are some additional example simulation requests that include multiple energy sites. The GetSimulationResultResponse will contain the results for each energy site specified.

Note: Bulk request result responses are limited to 2 million lines. You can determine the number of lines that will be returned in your response by using the following equation: Number of EnergySites in Request * Number of Hours between StartTime and EndTime * (60 / TemporalResolution_Minutes).

{
  "EnergySites": [
    {
      "EnergySiteId": "D7RCV0GWVQ"
    },
    {
      "EnergySiteId": "3MA0Z5H564"
    },
    {
      "EnergySiteId": "DYQX7DUVWG"
    },
    {
      "EnergySiteId": "L26ZDBF9P8"
    },
    {
      "EnergySiteId": "M8OGEJN1QI"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "PvLib",
    "SnowLossModel": "None",
    "SoilingLossModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "PowerDC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "DataVersion"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.01,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-01-01T15:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit",
      "ProbabilityOfExceedance": 0
    }
  }
}

{
  "EnergySites": [
    {
      "EnergySiteId": "NZ3RTPHLJE"
    },
    {
      "EnergySiteId": "6N0QX6E2U9"
    },
    {
      "EnergySiteId": "NBGTY7NBK2"
    },
    {
      "EnergySiteId": "FCDVD4A2CQ"
    },
    {
      "EnergySiteId": "6FTJ1WT0PM"
    },
    {
      "EnergySiteId": "XA70N15TNW"
    }
  ],
  "SimulationOptions": {
    "PowerModel": "CprPVForm",
    "ShadingModel": "Default",
    "SnowLossModel": "None",
    "SoilingLossModel": "None",
    "OutputFields": [
      "StartTime",
      "EndTime",
      "PowerAC_kW",
      "PowerDC_kW",
      "EnergyAC_kWh",
      "GlobalHorizontalIrradiance_WattsPerMeterSquared",
      "IrradianceObservationType",
      "DataVersion"
    ],
    "WeatherDataOptions": {
      "SpatialResolution_Degrees": 0.1,
      "TimeResolution_Minutes": 60,
      "StartTime": "2020-01-01T00:00:00-08:00",
      "EndTime": "2020-01-01T15:00:00-08:00",
      "WeatherDataSource": "SolarAnywhereLatest",
      "MissingDataHandling": "Omit"
    }
  }
}

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="D7RCV0GWVQ"></EnergySite>
    <EnergySite EnergySiteId="3MA0Z5H564"></EnergySite>
    <EnergySite EnergySiteId="DYQX7DUVWG"></EnergySite>
    <EnergySite EnergySiteId="L26ZDBF9P8"></EnergySite>
    <EnergySite EnergySiteId="M8OGEJN1QI"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="PvLib" 
  SnowLossModel="None"
  SoilingLossModel="None"
  OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-01-01T15:00:00-08:00"
    SpatialResolution_Degrees="0.01"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="NZ3RTPHLJE"></EnergySite>
    <EnergySite EnergySiteId="6N0QX6E2U9"></EnergySite>
    <EnergySite EnergySiteId="NBGTY7NBK2"></EnergySite>
    <EnergySite EnergySiteId="FCDVD4A2CQ"></EnergySite>
    <EnergySite EnergySiteId="6FTJ1WT0PM"></EnergySite>
    <EnergySite EnergySiteId="XA70N15TNW"></EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="CprPVForm"
  OutputFields="StartTime,EndTime,PowerAC_kW,PowerDC_kW,EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhereLatest"
    StartTime="2020-01-01T00:00:00-08:00"
    EndTime="2020-01-01T15:00:00-08:00"
    SpatialResolution_Degrees="0.1"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

Cookie	Duration	Description
CloudFlare CDN	4 weeks	This cookie is set by CloudFare to identify individual clients behind a shared IP address and apply security settings on a per-client basis. It does not correspond to any user ID in the web application and does not store any personally identifiable information.
CookieLawInfo Checkbox Necessary	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category ‘Strictly Necessary’.
CookieLawInfo Checkbox Performance	11 months	This cookie is set by GDPR Cookie Consent plugin. The purpose of this cookie is to check whether or not the user has given the consent to the usage of cookies under the category ‘Performance’.
CookieLawInfo Checkbox Personalization	11 months	This cookie is set by GDPR Cookie Consent plugin. The purpose of this cookie is to check whether or not the user has given the consent to the usage of cookies under the category ‘Enhancements & Personalization’.
Viewed Cookie Policy	1 hour	This cookie is set by the GDPR Cookie Consent plugin and is used to store whether or not user has consented to the use of cookies. It does not store any personal data.
Website Search Interaction	Session	This cookie is set by Site Search 360, our search engine for all Clean Power Research websites, to record search session preferences and performance.
Website Search Session ID	11 months	This cookie is set by Site Search 360, our search engine for all Clean Power Research websites, to record search session preferences.

Cookie	Duration	Description
Google Analytics Data Limiter	1 minute	This cookie is installed by Google Universal Analytics to throttle the request rate to limit the colllection of data on high traffic sites.
Google Analytics Page Visits	1 day	This cookie is installed by Google Analytics. The cookie is used to store information of how visitors use a website and helps in creating an analytics report of how the wbsite is doing. The data collected including the number visitors, the source where they have come from, and the pages visted in an anonymous form.
Google Analytics Random Identifier	2 years	This cookie is installed by Google Analytics. The cookie is used to calculate visitor, session, campaign data and keep track of site usage for the site’s analytics report. The cookie stores information anonymously and assigns a randomly generated number to identify unique visitors.
Marketo Tracking	2 years	This cookie is associated with an email marketing service provided by Marketo. This tracking cookie allows the website to link visitor behavior to the recipient of an email marketing campaign, to measure campaign effectiveness.

Cookie	Duration	Description
Wistia Videos	11 months	Set by Wistia to support video functionality that may be found throughout the website. In addition to keeping track of the website visitor's position in a video should playback be interrupted, this cookie also notes user behavior regarding the video itself.
Wistia Videos Data	10 months	This cookie collects visitor interaction data regarding Wistia video content so that such content can be made more relevant to the visitor.