CreateSimulationRequest

Basic Asynchronous Request

Method: POST
URL: https://service.solaranywhere.com/api/v2/Simulation?key=CLIENT_KEY

Below is an example simulation request for irradiance, weather, energy, and power output data using an energy site ID. Energy site IDs are a component of the EnergySiteCreateResponse.

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite EnergySiteId="NZ3RTPHLJE">
    </EnergySite>
  </EnergySites>
  <SimulationOptions
  PowerModel="CprPVForm"
  ShadingModel="MonthlyPercentSolarResource" 
  OutputFields="StartTime,ObservationTime,EndTime,PowerAC_kW,
    EnergyAC_kWh,GlobalHorizontalIrradiance_WattsPerMeterSquared,DirectNormalIrradiance_WattsPerMeterSquared,
    DiffuseHorizontalIrradiance_WattsPerMeterSquared,IrradianceObservationType,AmbientTemperature_DegreesC,
    AmbientTemperatureObservationType,WindSpeed_MetersPerSecond,WindSpeedObservationType,
    PlaneOfArrayIrradiance_WattsPerMeterSquared,CapacitySimulatedDC_Percent,CapacitySimulatedDC_kW,
    ClearSkyPowerAC_kW,ClearSkyEnergyAC_kWh,RelativeHumidity_Percent,SnowDepth_Meters,LiquidPrecipitation_KilogramsPerMeterSquared,
    SolidPrecipitation_KilogramsPerMeterSquared">
    <WeatherDataOptions
    WeatherDataSource="SolarAnywhere3_4"
    WeatherDataPreference = "Auto"
    PerformTimeShifting = "true"
    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>

Element and Attribute Names

Simulation Options

PowerModel:

The Clean Power Research simulation tool uses an implementation of Sandia’s PVFORM power output model
called “CprPVForm.” This is specified by PowerModel = “CprPVForm” in the SimulationOptions element.

For more information on how it works visit the
PV simulation section of the terms and concepts page.

ShadingModel:

OutputFields:

The output field values that can be requested for each simulation period returned. For more information, see Irradiance and Weather Data – Terms and Concepts or Solar Simulations – Terms and Concepts.

  • StartTime
  • ObservationTime
  • EndTime
  • PowerAC_kW
  • EnergyAC_kWh
  • GlobalHorizontalIrradiance_WattsPerMeterSquared
  • DirectNormalIrradiance_WattsPerMeterSquared
  • DiffuseHorizontalIrradiance_WattsPerMeterSquared
  • IrradianceObservationType
  • AmbientTemperature_DegreesC
  • AmbientTemperatureObservationType
  • WindSpeed_MetersPerSecond
  • WindSpeedObservationType
  • PlaneOfArrayIrradiance_WattsPerMeterSquared
  • ForecastLeadTime_Minutes
  • CapacitySimulatedDC_Percent
  • CapacitySimulatedDC_kW
  • ClearSkyPowerAC_kW
  • ClearSkyEnergyAC_kWh
  • RelativeHumidity_Percent
  • SnowDepth_Meters
  • LiquidPrecipitation_KilogramsPerMeterSquared
  • SolidPrecipitation_KilogramsPerMeterSquared

SummaryOutputFields:

  • TotalEnergy
  • TotalGlobalHorizontalIrradiance
  • TotalDirectNormalIrradiance
  • TotalLiquidPrecipitation
  • TotalSolidPrecipitation
  • AverageSnowDepth
  • AverageWindSpeed
  • AverageAmbientTemperature

WeatherDataOptions

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.

Frequently Asked Questions

How do I model Enphase microinverters using the SolarAnywhere simulation tool?

The recommended approach for modeling microinverters is to set 1 inverter per module and
adjust the GeneralDerate_Percent consistent with the manufacturer’s recommendations.

How do I model DC optimizers using the SolarAnywhere simulation tool?

The electrical behavior of DC optimizers varies by manufacturer and requires detailed modeling for
each technology. The recommended approach for modeling DC optimizers in the model is to adjust
the GeneralDerate_Percent consistent with the manufacturer’s recommendations.

CreateSimulationRequest Examples

Example request payloads that include aggregated results by month and year for each summary field in Summary element. These can be calculated using time series data or TGY data.

Method: POST
URL: https://service.solaranywhere.com/api/v2/Simulation?key=CLIENT_KEY

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite Name="Sample site" Description="Site Description">
      <Location Latitude="34.65" Longitude="-119.1" />
      <PvSystems>
        <PvSystem Albedo_Percent="17" GeneralDerate_Percent="85.00">
          <Inverters>
            <Inverter Count="1" MaxPowerOutputAC_kW="4.470000" EfficiencyRating_Percent="97.000000" />
          </Inverters>
          <PvArrays>
            <PvArray>
              <PvModules>
                <PvModule Count="1" NameplateDCRating_kW="0.22000" PtcRating_kW="0.19760" 
                  PowerTemperatureCoefficient_PercentPerDegreeC="0.4" NominalOperatingCellTemperature_DegreesC="45" />
              </PvModules>
              <ArrayConfiguration Azimuth_Degrees="177.000" Tilt_Degrees="25.000" Tracking="Fixed" 
                TrackingRotationLimit_Degrees="90" ModuleRowCount="1" RelativeRowSpacing="3" />
              <MonthlyShadings>
                <MonthlyShading MonthNumber="1" SolarAccess_Percent="77.0" />
                <MonthlyShading MonthNumber="2" SolarAccess_Percent="87.0" />
                <MonthlyShading MonthNumber="3" SolarAccess_Percent="98.0" />
                <MonthlyShading MonthNumber="4" SolarAccess_Percent="100.0" />
                <MonthlyShading MonthNumber="5" SolarAccess_Percent="100.0" />
                <MonthlyShading MonthNumber="6" SolarAccess_Percent="100.0" />
                <MonthlyShading MonthNumber="7" SolarAccess_Percent="100.0" />
                <MonthlyShading MonthNumber="8" SolarAccess_Percent="100.0" />
                <MonthlyShading MonthNumber="9" SolarAccess_Percent="100.0" />
                <MonthlyShading MonthNumber="10" SolarAccess_Percent="100.0" />
                <MonthlyShading MonthNumber="11" SolarAccess_Percent="100.0" />
                <MonthlyShading MonthNumber="12" SolarAccess_Percent="91.0" />
              </MonthlyShadings>
            </PvArray>
          </PvArrays>
        </PvSystem>
      </PvSystems>
    </EnergySite>
  </EnergySites>
  <SimulationOptions PowerModel="CprPVForm" ShadingModel="MonthlyPercentSolarResource" 
    SummaryOutputFields="TotalEnergy,TotalGlobalHorizontalIrradiance,TotalDirectNormalIrradiance">
    <WeatherDataOptions WeatherDataSource="SolarAnywhere3_4"
      WeatherDataPreference = "Auto" PerformTimeShifting = "true" 
      StartTime="2019-01-01T00:00:00-08:00" EndTime="2020-01-01T00:00:00-08:00" 
      SpatialResolution_Degrees="0.1" TimeResolution_Minutes="60" />
  </SimulationOptions>
</CreateSimulationRequest>
<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite Name="Sample site" Description="Site Description">
      <Location Latitude="34.65" Longitude="-119.1" />
      <PvSystems>
        <PvSystem Albedo_Percent="17" GeneralDerate_Percent="85.00">
          <Inverters>
            <Inverter Count="1" MaxPowerOutputAC_kW="4.470000" EfficiencyRating_Percent="97.000000" />
          </Inverters>
          <PvArrays>
            <PvArray>
              <PvModules>
                <PvModule Count="1" NameplateDCRating_kW="0.22000" PtcRating_kW="0.19760" 
                  PowerTemperatureCoefficient_PercentPerDegreeC="0.4"
                  NominalOperatingCellTemperature_DegreesC="45" />
              </PvModules>
              <ArrayConfiguration Azimuth_Degrees="177.000" Tilt_Degrees="25.000" Tracking="Fixed" 
                TrackingRotationLimit_Degrees="90" ModuleRowCount="1" RelativeRowSpacing="3" />
              <SolarObstructions>
                <SolarObstruction Azimuth_Degrees="90.000" Elevation_Degrees="33.000" Opacity_Percent="80" />
                <SolarObstruction Azimuth_Degrees="120.000" Elevation_Degrees="50.000" />
                <SolarObstruction Azimuth_Degrees="150.000" Elevation_Degrees="22.000" />
                <SolarObstruction Azimuth_Degrees="180.000" Elevation_Degrees="3.000" />
                <SolarObstruction Azimuth_Degrees="210.000" Elevation_Degrees="1.000" />
                <SolarObstruction Azimuth_Degrees="240.000" Elevation_Degrees="2.000" />
                <SolarObstruction Azimuth_Degrees="270.000" Elevation_Degrees="4.000" Opacity_Percent="70" />
              </SolarObstructions>
            </PvArray>
          </PvArrays>
        </PvSystem>
      </PvSystems>
    </EnergySite>
  </EnergySites>
  <SimulationOptions PowerModel="CprPVForm" ShadingModel="ShadeSimulator" 
    SummaryOutputFields="TotalEnergy,TotalGlobalHorizontalIrradiance,TotalDirectNormalIrradiance">
    <WeatherDataOptions WeatherDataSource="SolarAnywhereTGY2019"
      WeatherDataPreference = "Auto" PerformTimeShifting = "true" 
      SpatialResolution_Degrees="0.1" TimeResolution_Minutes="60" />
  </SimulationOptions>
</CreateSimulationRequest>