CreateSimulationRequest

Basic Asynchronous Request

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite Name="BulkSimulation V2 Site" Description="Site Description">
      <Location Latitude="34.65" Longitude="-119.1" />
      <PvSystems>
        <PvSystem Albedo_Percent="17" GeneralDerate_Percent="85.0">
          <Inverters>
            <Inverter Count="1" MaxPowerOutputAC_kW="4.470000" EfficiencyRating_Percent="97.0" />
          </Inverters>
          <PvArrays>
            <PvArray>
              <PvModules>
                <PvModule Count="12" NameplateDCRating_kW="0.220" PtcRating_kW="0.19760" PowerTemperatureCoefficient_PercentPerDegreeC="0.4"  NominalOperatingCellTemperature_DegreesC="45" />
              </PvModules>
              <ArrayConfiguration Azimuth_Degrees="177.0" Tilt_Degrees="25.0" Tracking="Fixed" TrackingRotationLimit_Degrees="90" ModuleRowCount="1" RelativeRowSpacing="3"  />
              <SolarObstructions>
                <SolarObstruction Azimuth_Degrees="90.0" Elevation_Degrees="33.0"  Opacity_Percent="80"/>
                <SolarObstruction Azimuth_Degrees="120.0" Elevation_Degrees="50.0" />
                <SolarObstruction Azimuth_Degrees="150.0" Elevation_Degrees="22.0" />
                <SolarObstruction Azimuth_Degrees="180.0" Elevation_Degrees="3.0" />
                <SolarObstruction Azimuth_Degrees="210.0" Elevation_Degrees="1.0" />
                <SolarObstruction Azimuth_Degrees="240.0" Elevation_Degrees="2.0" />
                <SolarObstruction Azimuth_Degrees="270.0" Elevation_Degrees="4.0"  Opacity_Percent="70"/>
              </SolarObstructions>
              <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>
    <EnergySite Name="Tokyo Site" Description="No Weather Data Available">
      <Location Latitude="35.42" Longitude="-139.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="10" NameplateDCRating_kW="0.220" PtcRating_kW="0.19760" PowerTemperatureCoefficient_PercentPerDegreeC="0.4" NominalOperatingCellTemperature_DegreesC="45" />
              </PvModules>
              <ArrayConfiguration Azimuth_Degrees="177.0" Tilt_Degrees="25.0" Tracking="Fixed" TrackingRotationLimit_Degrees="90" ModuleRowCount="1" RelativeRowSpacing="3"  />
              <SolarObstructions>
                <SolarObstruction Azimuth_Degrees="90.0" Elevation_Degrees="33.0"  Opacity_Percent="80"/>
                <SolarObstruction Azimuth_Degrees="120.0" Elevation_Degrees="50.0" />
                <SolarObstruction Azimuth_Degrees="150.0" Elevation_Degrees="22.0" />
                <SolarObstruction Azimuth_Degrees="180.0" Elevation_Degrees="3.0" />
                <SolarObstruction Azimuth_Degrees="210.0" Elevation_Degrees="1.0" />
                <SolarObstruction Azimuth_Degrees="240.0" Elevation_Degrees="2.0" />
                <SolarObstruction Azimuth_Degrees="270.0" Elevation_Degrees="4.0"  Opacity_Percent="70"/>
              </SolarObstructions>
              <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="CleanPowerEstimator"
  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_2"
    WeatherDataPreference = "Auto"
    PerformTimeShifting = "true"
    StartTime="2017-01-01T09:00:00-08:00"
    EndTime="2017-01-01T11:00:00-08:00"
    SpatialResolution_Degrees="0.1"
    TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>

Element and Attribute Names

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
  • CapacitySimulatedDC_Percent
  • CapacitySimulatedDC_kW
  • ClearSkyPowerAC_kW
  • ClearSkyEnergyAC_kWh
  • RelativeHumidity_Percent
  • SnowDepth_Meters
  • LiquidPrecipitation_KilogramsPerMeterSquared
  • SolidPrecipitation_KilogramsPerMeterSquared

Simulation Options

These apply to all EnergySite simulation results. For more information, see Solar Simulation – Terms & Concepts.

PowerModel:

  • CprPVForm
  • CleanPowerEstimator

ShadingModel:

  • ShadeSimulator
  • MonthlyPercentSolarResource

SummaryOutputFields:

  • TotalEnergy
  • TotalGlobalHorizontalIrradiance
  • TotalDirectNormalIrradiance

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.

For instance, specifying WeatherDataSource=”SolarAnywhere3_2″ will return time-series data, whereas specifying WeatherDataSource=”SolarAnywhereTGY2016″ will return typical year data.

WeatherDataSource specifies the solar model used in generating the irradiance and PV simulation OutputFields. Possible values include:

  • SolarAnywhere2_5
  • SolarAnywhere3_2
  • TMY3
  • SolarAnywhereTGY2012
  • SolarAnywhereTDY2012
  • SolarAnywhereTGY2016
  • SolarAnywhereTDY2016

WeatherDataPreference indicates the satellite reference for the irradiance generation.  Possible values include:

  • Auto – default for unspecified. Recommended.
  • USWestSatellite
  • USEastSatellite

PerformTimeShifting specifies the time-period averaging in the OutputFields.  Possible values include:

  • true – Recommended. For instance, StartTime =2011-11-11T00:00:00-08:00, EndTime = 2011-11-11T00:01:00-08:00.
  • false  – For instance, GOES-W: StartTime = 2011-11-11T00:00:30-08:00, EndTime = 2011-11-11T00:01:30-08:00.

StartTime specifies the absolute start time of the request.  Follows date:time plus GMT offset convention out of ISO_8601, for example: YYYY-MM-DDTHH:MM:SS-XX:YY, where XX:YY reflects the GMT offset (+ or -). For instance, StartTime = “2011-01-01T09:00:00-08:00”

EndTime specifies the absolute end time of the request.  Follows date:time plus GMT offset convention out of ISO_8601, for example: YYYY-MM-DDTHH:MM:SS-XX:YY, where XX:YY reflects the GMT offset (+ or -). For instance, EndTime = “2011-01-01T11:00:00-08:00”

SpatialResolution_Degrees specifies the desired spatial resolution of the irradiance-specific OutputFields and SummaryOutputFields. Possible values include:

  • 0.1 – corresponds to the 10-km grid
  • 0.01 – corresponds to the 1-km grid

TimeResolution_Minutes specifies the desired time resolution of all OutputFields (similar to SpatialResolution_Degrees, as noted above). For more detailed information, see Irradiance and Weather Data Options. Possible values include:

  • 60
  • 30
  • 15
  • 10
  • 5
  • 1

MissingDataHandling specifies the handling of periods with missing solar model inputs. Missing inputs occur on rare occasions, typically when the satellite image used to predict irradiance is not available. Periods with options for handling must be missing consecutive periods of three (3) hours or longer. For periods of two (2) hours or less, persistence is applied automatically. Possible values include:

 

  • Blanks
  • FillAverage

CreateSimulationRequest Examples

Example request payloads that include aggregated results by month and year for each summary field in Summary element.

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

<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite Name="BulkSimulation V2 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  NameplateDCRating_kW="0.22000" PtcRating_kW="0.19760" 
                 PowerTemperatureCoefficient_PercentPerDegreeC="150"  
                 NominalOperatingCellTemperature_DegreesC="45" />
              </PvModules>
              <ArrayConfiguration Azimuth_Degrees="177.000" Tilt_Degrees="25.000" Tracking="Fixed" 
               TrackingRotationLimit_Degrees="90" ModuleRowCount="1" RelativeRowSpacing="3"  />
              <SolarObstructions/>
              <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_2"
   WeatherDataPreference = "Auto"
   PerformTimeShifting = "true"
   SpatialResolution_Degrees="0.1"
   TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>
<CreateSimulationRequest xmlns="http://service.solaranywhere.com/api/v2">
  <EnergySites>
    <EnergySite Name="BulkSimulation V2 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  NameplateDCRating_kW="0.22000" PtcRating_kW="0.19760" 
                 PowerTemperatureCoefficient_PercentPerDegreeC="150"  
                 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>
              <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="CleanPowerEstimator"
  ShadingModel="MonthlyPercentSolarResource"
  SummaryOutputFields="TotalEnergy,TotalGlobalHorizontalIrradiance,
  TotalDirectNormalIrradiance">
    <WeatherDataOptions
     WeatherDataSource="SolarAnywhereTGY2016"
     WeatherDataPreference = "Auto"
     PerformTimeShifting = "true"
     SpatialResolution_Degrees="0.1"
     TimeResolution_Minutes="60"/>
  </SimulationOptions>
</CreateSimulationRequest>