Welcome to S5’s documentation!

SolarSim Strategy Support Software (S5) is intended to be used in conjunction with SolarSim, to prepare input data, run SolarSim simulations, and visualise results.

Contents

• API Documentation
  • S5
    • S5.HPC
      • S5.HPC.SolarSim
        • S5.HPC.SolarSim.const_vel
          • const_vel()
        • S5.HPC.SolarSim.file_swap
          • file_swap()
        • S5.HPC.SolarSim.file_sweep
          • file_sweep()
        • S5.HPC.SolarSim.file_sweep_par
          • file_sweep_par()
        • S5.HPC.SolarSim.read_file_sweep
          • read_file_sweep()
        • S5.HPC.SolarSim.read_vel_sweep
          • read_vel_sweep()
        • S5.HPC.SolarSim.run_ss
          • run_ss()
        • S5.HPC.SolarSim.vel_sweep
          • vel_sweep()
        • S5.HPC.SolarSim.vel_sweep_par
          • vel_sweep_par()
      • S5.HPC.file_io
        • S5.HPC.file_io.adjust_v
          • adjust_v()
        • S5.HPC.file_io.lin2win
          • lin2win()
        • S5.HPC.file_io.read_history
          • read_history()
        • S5.HPC.file_io.win2lin
          • win2lin()
        • S5.HPC.file_io.write_vel
          • write_vel()
      • S5.HPC.optimisation
        • S5.HPC.optimisation.calc_strat
          • calc_strat()
        • S5.HPC.optimisation.calc_strat_new
          • calc_strat_new()
        • S5.HPC.optimisation.extract_prime
          • extract_prime()
        • S5.HPC.optimisation.set_mean
          • set_mean()
    • S5.Tecplot
      • S5.Tecplot.DSWinput
        • DSWinput
          • DSWinput.__init__()
          • DSWinput.format()
          • DSWinput.get_value()
          • DSWinput.readfile()
          • DSWinput.set_value()
          • DSWinput.write_input()
      • S5.Tecplot.SSHistory
        • SSHistory
          • SSHistory.__init__()
          • SSHistory.add_timestamp()
          • SSHistory.check_zone()
          • SSHistory.readfile()
          • SSHistory.summary()
          • SSHistory.update_zone_1d()
          • SSHistory.write_tecplot()
      • S5.Tecplot.SSWeather
        • SSWeather
          • SSWeather.__init__()
          • SSWeather.add_day_time_cols()
          • SSWeather.add_timestamp()
          • SSWeather.check_rectangular()
          • SSWeather.check_zone()
          • SSWeather.readfile()
          • SSWeather.update_zone_1d()
          • SSWeather.write_tecplot()
      • S5.Tecplot.TPHeaderZone
        • TPHeaderZone
          • TPHeaderZone.zonetitle
          • TPHeaderZone.zonetype
          • TPHeaderZone.ni
          • TPHeaderZone.nj
          • TPHeaderZone.nk
          • TPHeaderZone.F
          • TPHeaderZone.__init__()
          • TPHeaderZone.to_string()
      • S5.Tecplot.TecplotData
        • TecplotData
          • TecplotData.title
          • TecplotData.zone
          • TecplotData.data
          • TecplotData.__init__()
          • TecplotData.check_zone()
          • TecplotData.readfile()
          • TecplotData.update_zone_1d()
          • TecplotData.write_tecplot()
    • S5.Weather
      • S5.Weather.convert_wind
        • convert_wind()
      • S5.Weather.to_csv
        • to_csv()
      • S5.Weather.to_parquet
        • to_parquet()
      • S5.Weather.upload_file
        • upload_file()
      • S5.Weather.readgrib
        • S5.Weather.readgrib.cumulative_ssr_to_hourly
          • cumulative_ssr_to_hourly()
        • S5.Weather.readgrib.era5_spot
          • era5_spot()
        • S5.Weather.readgrib.extract_df
          • extract_df()
        • S5.Weather.readgrib.from_era5
          • from_era5()
        • S5.Weather.readgrib.ssr_to_direct_and_diffuse
          • ssr_to_direct_and_diffuse()
      • S5.Weather.solcast_forecast
        • S5.Weather.solcast_forecast.send_forecast_request
          • send_forecast_request()
        • S5.Weather.solcast_forecast.send_live_request
          • send_live_request()
        • S5.Weather.solcast_forecast.send_request_old
          • send_request_old()
      • S5.Weather.solcast_historic
        • S5.Weather.solcast_historic.get_file_list
          • get_file_list()
        • S5.Weather.solcast_historic.main
          • main()
        • S5.Weather.solcast_historic.map_files
          • map_files()
        • S5.Weather.solcast_historic.read_solcast_csv
          • read_solcast_csv()
      • S5.Weather.tomorrow_forecast
        • S5.Weather.tomorrow_forecast.send_request
          • send_request()
    • S5.nonosquare
      • S5.nonosquare.why
        • why()
    • S5.tests
      • S5.tests.conftest
        • S5.tests.conftest.history_df
          • history_df()
        • S5.tests.conftest.history_file
          • history_file()
        • S5.tests.conftest.history_tp
          • history_tp()
        • S5.tests.conftest.road_file
          • road_file()
        • S5.tests.conftest.solarsim_in
          • solarsim_in()
        • S5.tests.conftest.velocity_file
          • velocity_file()
        • S5.tests.conftest.weather_file
          • weather_file()
      • S5.tests.test_SolarSim
        • S5.tests.test_SolarSim.mock_Popen
          • mock_Popen()
        • S5.tests.test_SolarSim.mock_read_history
          • mock_read_history()
        • S5.tests.test_SolarSim.mock_sp
          • mock_sp()
        • S5.tests.test_SolarSim.test_const_vel
          • test_const_vel()
        • S5.tests.test_SolarSim.test_file_swap
          • test_file_swap()
        • S5.tests.test_SolarSim.test_file_sweep_output_filename
          • test_file_sweep_output_filename()
        • S5.tests.test_SolarSim.test_file_sweep_par
          • test_file_sweep_par()
        • S5.tests.test_SolarSim.test_file_sweep_times_called
          • test_file_sweep_times_called()
        • S5.tests.test_SolarSim.test_read_file_sweep
          • test_read_file_sweep()
        • S5.tests.test_SolarSim.test_read_vel_sweep
          • test_read_vel_sweep()
        • S5.tests.test_SolarSim.test_run_ss
          • test_run_ss()
        • S5.tests.test_SolarSim.test_run_ss_timeout
          • test_run_ss_timeout()
        • S5.tests.test_SolarSim.test_run_ss_with_lock
          • test_run_ss_with_lock()
        • S5.tests.test_SolarSim.test_vel_sweep_output_filename
          • test_vel_sweep_output_filename()
        • S5.tests.test_SolarSim.test_vel_sweep_par
          • test_vel_sweep_par()
        • S5.tests.test_SolarSim.test_vel_sweep_times_called
          • test_vel_sweep_times_called()
      • S5.tests.test_Tecplot
        • S5.tests.test_Tecplot.test_DSWinput_bad_value
          • test_DSWinput_bad_value()
        • S5.tests.test_Tecplot.test_DSWinput_format
          • test_DSWinput_format()
        • S5.tests.test_Tecplot.test_DSWinput_get_value
          • test_DSWinput_get_value()
        • S5.tests.test_Tecplot.test_DSWinput_read_write
          • test_DSWinput_read_write()
        • S5.tests.test_Tecplot.test_DSWinput_set_value
          • test_DSWinput_set_value()
        • S5.tests.test_Tecplot.test_bad_read_tecplot_file
          • test_bad_read_tecplot_file()
        • S5.tests.test_Tecplot.test_check_zone
          • test_check_zone()
        • S5.tests.test_Tecplot.test_construct_DWSinnput
          • test_construct_DWSinnput()
        • S5.tests.test_Tecplot.test_headerzone_to_string
          • test_headerzone_to_string()
        • S5.tests.test_Tecplot.test_hist_tp
          • test_hist_tp()
        • S5.tests.test_Tecplot.test_history_add_timestamp
          • test_history_add_timestamp()
        • S5.tests.test_Tecplot.test_history_read
          • test_history_read()
        • S5.tests.test_Tecplot.test_print_headerzone
          • test_print_headerzone()
        • S5.tests.test_Tecplot.test_print_tpdata
          • test_print_tpdata()
        • S5.tests.test_Tecplot.test_read_DSWinput
          • test_read_DSWinput()
        • S5.tests.test_Tecplot.test_read_bad_title
          • test_read_bad_title()
        • S5.tests.test_Tecplot.test_read_bad_var_title
          • test_read_bad_var_title()
        • S5.tests.test_Tecplot.test_read_bad_zone_title
          • test_read_bad_zone_title()
        • S5.tests.test_Tecplot.test_read_tecplot_file
          • test_read_tecplot_file()
        • S5.tests.test_Tecplot.test_read_write
          • test_read_write()
        • S5.tests.test_Tecplot.test_read_write_with_datum
          • test_read_write_with_datum()
        • S5.tests.test_Tecplot.test_tecplotdata_constructor
          • test_tecplotdata_constructor()
        • S5.tests.test_Tecplot.test_tecplotheaderzone_constructor
          • test_tecplotheaderzone_constructor()
        • S5.tests.test_Tecplot.test_weather_add_day_time_cols
          • test_weather_add_day_time_cols()
        • S5.tests.test_Tecplot.test_weather_add_day_time_cols_invalid_index
          • test_weather_add_day_time_cols_invalid_index()
        • S5.tests.test_Tecplot.test_weather_add_timestamp
          • test_weather_add_timestamp()
        • S5.tests.test_Tecplot.test_weather_check_rectangular
          • test_weather_check_rectangular()
        • S5.tests.test_Tecplot.test_weather_read
          • test_weather_read()
        • S5.tests.test_Tecplot.test_write_empty
          • test_write_empty()
      • S5.tests.test_file_io
        • S5.tests.test_file_io.test_adjust_v
          • test_adjust_v()
        • S5.tests.test_file_io.test_history_summary
          • test_history_summary()
        • S5.tests.test_file_io.test_history_summary_avgvel
          • test_history_summary_avgvel()
        • S5.tests.test_file_io.test_lin2win
          • test_lin2win()
        • S5.tests.test_file_io.test_win2lin
          • test_win2lin()
        • S5.tests.test_file_io.test_write_vel_default_name
          • test_write_vel_default_name()
        • S5.tests.test_file_io.test_write_vel_float
          • test_write_vel_float()
        • S5.tests.test_file_io.test_write_vel_int
          • test_write_vel_int()
        • S5.tests.test_file_io.test_write_vel_pandas
          • test_write_vel_pandas()
      • S5.tests.test_nonosquare
        • S5.tests.test_nonosquare.test_why
          • test_why()
      • S5.tests.test_optimisation
        • S5.tests.test_optimisation.test_calc_strat
          • test_calc_strat()
        • S5.tests.test_optimisation.test_calc_strat_zero
          • test_calc_strat_zero()
        • S5.tests.test_optimisation.test_set_mean
          • test_set_mean()
        • S5.tests.test_optimisation.test_set_mean_clip_kph
          • test_set_mean_clip_kph()
        • S5.tests.test_optimisation.test_set_mean_clip_kph_lin
          • test_set_mean_clip_kph_lin()
        • S5.tests.test_optimisation.test_set_mean_clip_ms
          • test_set_mean_clip_ms()
        • S5.tests.test_optimisation.test_set_mean_const
          • test_set_mean_const()
        • S5.tests.test_optimisation.test_set_mean_linear
          • test_set_mean_linear()
      • S5.tests.test_readgrib
        • S5.tests.test_readgrib.grib_df
          • grib_df()
        • S5.tests.test_readgrib.mock_extract_df
          • mock_extract_df()
        • S5.tests.test_readgrib.test_calculate_wind
          • test_calculate_wind()
        • S5.tests.test_readgrib.test_cumulative_ssr_to_hourly_complex
          • test_cumulative_ssr_to_hourly_complex()
        • S5.tests.test_readgrib.test_cumulative_ssr_to_hourly_one_day
          • test_cumulative_ssr_to_hourly_one_day()
        • S5.tests.test_readgrib.test_era5_spot
          • test_era5_spot()
        • S5.tests.test_readgrib.test_from_era5
          • test_from_era5()
        • S5.tests.test_readgrib.test_from_era5_backfill
          • test_from_era5_backfill()
        • S5.tests.test_readgrib.test_from_era5_no_solar
          • test_from_era5_no_solar()
      • S5.tests.test_solcast_forecast
        • S5.tests.test_solcast_forecast.mock_solcast_response
          • mock_solcast_response()
        • S5.tests.test_solcast_forecast.test_send_forecast_requests
          • test_send_forecast_requests()
        • S5.tests.test_solcast_forecast.test_send_forecast_requests_timeout
          • test_send_forecast_requests_timeout()
        • S5.tests.test_solcast_forecast.test_send_live_requests
          • test_send_live_requests()
        • S5.tests.test_solcast_forecast.test_send_live_requests_timeout
          • test_send_live_requests_timeout()
        • S5.tests.test_solcast_forecast.test_send_request
          • test_send_request()
        • S5.tests.test_solcast_forecast.test_send_request_failure
          • test_send_request_failure()
        • S5.tests.test_solcast_forecast.MockResponse
          • MockResponse
            • MockResponse.__init__()
            • MockResponse.json()
      • S5.tests.test_solcast_historic
        • S5.tests.test_solcast_historic.mock_read_solcast_csv
          • mock_read_solcast_csv()
        • S5.tests.test_solcast_historic.solcast_hist_csv
          • solcast_hist_csv()
        • S5.tests.test_solcast_historic.test_get_file_list
          • test_get_file_list()
        • S5.tests.test_solcast_historic.test_main
          • test_main()
        • S5.tests.test_solcast_historic.test_main_mismatch_timezone
          • test_main_mismatch_timezone()
        • S5.tests.test_solcast_historic.test_map_files
          • test_map_files()
        • S5.tests.test_solcast_historic.test_map_files_missing_col
          • test_map_files_missing_col()
        • S5.tests.test_solcast_historic.test_map_files_missing_point_in_road
          • test_map_files_missing_point_in_road()
        • S5.tests.test_solcast_historic.test_read_solcast_csv
          • test_read_solcast_csv()
      • S5.tests.test_tomorrow_forecast
        • S5.tests.test_tomorrow_forecast.mock_tomorrow_response
          • mock_tomorrow_response()
        • S5.tests.test_tomorrow_forecast.test_send_request_execption
          • test_send_request_execption()
        • S5.tests.test_tomorrow_forecast.test_send_request_failure
          • test_send_request_failure()
        • S5.tests.test_tomorrow_forecast.test_send_request_success
          • test_send_request_success()
      • S5.tests.test_weather
        • S5.tests.test_weather.test_to_csv
          • test_to_csv()
        • S5.tests.test_weather.test_to_parquet
          • test_to_parquet()
    • S5.visualisation
      • S5.visualisation.get_weather
        • get_weather()
      • S5.visualisation.plot_airspeed
        • plot_airspeed()
      • S5.visualisation.plot_contor
        • plot_contor()
      • S5.visualisation.plot_trace
        • plot_trace()
• Indices and tables

Indices and tables

• Index

• Module Index

• Search Page