/*

This script writes data from a SAM PV Battery case to use as nputs to the 
SPECS Early Stage Decision Model Excel model.

Written and tested in SAM 2020.11.29r2 for SPECS v2

Instructions:
------------

1. Create a case or open the SAM file you plan to use to generate data for the 
   SPECS model. It should be a PV Battery / Commercial case with Peak shaving 
   one day look ahead dispatch.
   
2. Click Run (above) to generate a CSV file with data for the SPECS model.

3. Open the CSV file in Excel and the data from the CSV file to the appropriate
   sheet in the SPECS model workbook.

*/

// Functions ///////////////////////////////////////////////////////////////////

// return inverter nominal efficiency as fraction
function inv_eff()
{
	inv_model = get('inverter_model');
	if (inv_model == 0){ eff = get('inv_snl_eff_cec'); }
	elseif (inv_model == 1){ eff = get('inv_ds_eff'); }
	elseif (inv_model == 2){ eff = get('inv_pd_eff'); }
	elseif (inv_model == 3){ eff = get('inv_cec_cg_eff_cec'); }
	else { eff = 96; }
	return eff/100;
}

// truncate time series array to first year of data
function truncate_time_series( arr )
{
	ts_per_year = #arr/get('analysis_period');
	for ( i=0; i<ts_per_year; i++ )
	{
		arr_yr[i] = arr[i];
	}
	return arr_yr;
}

function get_data()
{
	// get inputs
	p_pv_dc = get( 'system_capacity' ); // PV Nameplate DC (kW)
	dc_ac = get( 'calculated_dcac_ratio' ); //DC-AC Ratio 
	array = get('dc_degradation');
	degradation = array[0]; // PV Degradation Rate
	p_batt_ac = get( 'batt_power_discharge_max_kwac' ); // Battery Power AC (kW)
	percent = get( 'batt_minimum_SOC' );
	soc_min = percent/100; // Battery Min State of Charge
	percent = get( 'batt_maximum_SOC' ); //
	soc_max = percent/100; // Battery Max State of Charge
	q_batt_dc = get( 'batt_computed_bank_capacity' );
	// Battery Energy Capacity (kWh) - AC
	if ( get('batt_ac_or_dc') == 0) 
	{
		// DC-connected: DC/DC conversion efficiency, inverter nominal efficiency
		 q_batt_ac = q_batt_dc * get( 'batt_dc_dc_efficiency' )/100 * inv_eff(); // Battery Energy Capacity AC (kWh)
	}
	else
	{
		// AC-connected: DC/AC conversion efficiency
		 q_batt_ac = q_batt_dc * get( 'batt_dc_ac_efficiency' )/100; // Battery Energy Capacity AC (kWh)
	}
	
	batt_can_charge_from_grid = get('batt_dispatch_auto_can_gridcharge'); // Battery can charge from grid
	batt_can_charge_from_system = get('batt_dispatch_auto_can_charge'); // Battery can charge from system

	// get outputs
	eff_batt = get('average_battery_roundtrip_efficiency'); // Battery Round Trip Efficiency
	ts = get('lifetime_load');
	if ( ts == null )
	{
		msgbox('No load data!\nThis script requires a configuration that uses load data.\n' + configuration() + ' does not use load data.\n\nExiting script.');
		exit;
	}
	ts_load = truncate_time_series( ts ); // Electricity load (year 1) (kW)
	ts = get('grid_to_batt');
	ts_grid_to_batt = truncate_time_series( ts ); // Electricity to battery from grid (kW)
	ts = get('system_to_batt');
	ts_system_to_batt = truncate_time_series( ts ); //Electricity to battery from system (kW) 
	ts = get('batt_to_load');
	ts_batt_to_load = truncate_time_series( ts ); //Electricity to load from battery (kW)
	ts = get('system_to_load');
	ts_system_to_load = truncate_time_series( ts ); //Electricity to load from system (kW)
	ts = get('batt_SOC');
	ts_soc = truncate_time_series( ts ); //Battery state of charge (%)

    // headers for single values
    arr[0][0] = 'PV DC nameplate (kW)';  
    arr[1][0] = 'DC-AC ratio';
    arr[2][0] = 'PV annual DC degradation rate';
    arr[3][0] = 'Battery AC power (kW)';
    arr[4][0] = 'Battery minimum state of charge';
    arr[5][0] = 'Battery maximum state of charge';
    arr[6][0] = 'Battery AC energy capacity (kWh)';
    arr[7][0] = 'Battery round trip efficiency (%)';
    arr[8][0] = 'Battery can charge from grid';
    arr[9][0] = 'Battery can charge from system';
    
    // headers for time series values
    arr[10][0] = 'Electricity load (kW)';
    arr[10][1] = 'Electricity to battery from grid (kW)';
    arr[10][2] = 'Electricity to battery from system (kW)';
    arr[10][3] = 'Electricity to load from battery (kW)';
    arr[10][4] = 'Electricity to load from system (kW)';
    arr[10][5] = 'Battery state of charge (%)';
    
    // data for single values
    arr[0][1] = p_pv_dc;
	arr[1][1] = dc_ac;
    arr[2][1] = degradation;
	arr[3][1] = p_batt_ac;
	arr[4][1] = soc_min;
	arr[5][1] = soc_max;
    arr[6][1] = q_batt_ac;
	arr[7][1] = eff_batt;
	arr[8][1] = batt_can_charge_from_grid;
	arr[9][1] = batt_can_charge_from_system;

	// data for time series
	x = 11;
	for ( i=0; i<#ts_load; i++ )
	{
		arr[x+i][0] = ts_load[i];
		arr[x+i][1] = ts_grid_to_batt[i];
		arr[x+i][2] = ts_system_to_batt[i];
		arr[x+i][3] = ts_batt_to_load[i];
		arr[x+i][4] = ts_system_to_load[i];
		arr[x+i][5] = ts_soc[i];
	}
	
	return arr;
}

// return message if case is not correctly configured to work with SPECS
function check_inputs()
{
	msg = '';

	config = configuration();
	if ( config[0] != 'PV Battery' || config[1] != 'Commercial' )
	{
		msg += '\n\nThe SPECS model requires SAM data for a PV Battery / Commercial case. This case is ' + config[0] + ' / ' + config[1] + '.';
		return msg; // don't run any more checks if configuration is wrong
	}
	
	dispatch = get('batt_dispatch_choice');
	options = [ 'Automated dispatch look ahead', 'Automated dispatch one day look behind', 'Automated dispatch custom weather file', 'Dispatch to custom time series', 'Manual dispatch' ];
	if ( dispatch > 0 )
	{ msg += '\n\nThe SPECS model requires the automated look ahead dispatch option (on the Battery Dispatch page). This case uses ' + options[dispatch] + '.'; }
	
	is_dc_connected = !get('batt_ac_or_dc');
	if ( is_dc_connected ) // dc connected battery
	{
		p_dc_batt = get('batt_max_power');
		p_ac = get('total_inverter_capacity');
		if ( p_dc_batt > p_ac ) 
		{
			msg += ('\n\nThe ' + sprintf('%.1f',p_dc_batt) + ' DC kW battery is DC-connected with a hybrid inverter capacity of ' + sprintf('%.1f',p_ac) + ' AC kW. You may want to check that the inverter is not limiting significant power from the battery or use a larger inverter by changing either the DC/AC ratio or number of inverters on the System Design page.');
		}
	}
	
	if ( !is_dc_connected ) // ac connected battery
	{
		is_pv_charge = get( 'batt_dispatch_auto_can_charge' );
		if ( is_pv_charge )
		{
			msg += ('\n\nThe battery is AC-connected with with \"Battery can charge from system\" enabled. For AC-connected batteries, the controller proritizes meeting the load from the PV array over charging the battery. If the peak load is much higher than the PV array peak power output, the battery may never charge unless it is allowed to charge from the grid. Switch to a DC-connected battery on the Battery Ceel and System page if you want the PV array to charge the battery.');
		}
		
	}
	
	return msg;
}

// Main ////////////////////////////////////////////////////////////////////////

outln('Checking inputs.');
msg = check_inputs();
if ( msg != '' )
{
	ok = yesno( 'SAM case may be incorrectly configured!\n'
	+ 'The SAM inputs for the \"' + active_case() + '\" case may not be configured properly to work with the SPECS model:' 
	+ msg
	+ '\n\nContinue anyway?');
	if ( !ok ) { exit; }
}

// Run a simulation to generate results
outln( 'Running simulation.' );
msg = '';
sim_ok = simulate( msg, false );
if ( ! sim_ok ) 
{
	msgbox( 'SAM simulation failed!\nExiting script. Simulation message: \n\n' + msg );
	exit; 
}

// Write data
outln( 'Getting data.' );
data_array = get_data();

// Write to CSV
f_csv = cwd() + '/sam-inputs-for-specs.csv';
csv_ok = csvwrite( f_csv, data_array );
if ( ! csv_ok ) 
{
	msgbox( 'Failed to write SAM data to CSV!\nMake sure that CSV file is not open in another program.\n\n' + f_csv );
	exit; 
}
else { outln('Success! Data written to CSV: ' + f_csv); }

outln( 'Done.' );