Some thoughts on arrays in and structure of optimisation result

[e-hirsch]

Understand more and more about the way EOS is working I want to share some thoughts that came up while I was dealing with the EOS optimisation results and make some suggestions how we could improve them.

Arrays

Some arrays have a size of 48 elements, some have a size of 48-current_hour elements. At least for me it took a while to understand how to interpret it and how to handle the arrays to pick the correct elements for controlling the relevant devices (finally align them to the right).

I still don't understand why I should need the values of the elements 0 to current_hour to control the relevant devices. Wouldn't it be more consistent (and easier to understand) to have all arrays in the result of the same size of 48-current_hour?

Structure

Wouldn't it make more sense to have ac_charge, dc_charge, discharge_allowed and eautocharge_hours_float as a part of the result object?
And couldn't we structure the result object by grouping some elements? E.g. "EV", "Battery", "Cost", "Load"/"Power", "Home devices"
And why is "Electricity_price" part of the result? It doesn't change during the optimisation so it shouldn't be a part of the result object. And as far as I can see no other input value is part of the optimisation result.

Naming

Some of the names of the objects may be hard to understand and commit to certain concepts that may not necessarily exist everywhere in this form. Example: if you think of ac coupled batteries, dc_charge doesn't really make sense. And it took me a while to understand that ac_charge denotes the factor relative to the max. charge power of the home battery. So here are some suggestions for alternative naming:

ac_charge => charge_from_grid or charge_from_grid_factor
dc_charge => charge_from_pv ...
discharge_allowed => pv_battery_discharge_allowed

Some names are inconsistent to the other conventions or/and are in mixed language "denglisch" ;-)

eautocharge_hours_float => ev_charge_factor
EAuto_SoC_pro_Stunde => ev_soc_per_hour

(And in the input some objects are in german language while the attributes are in english language)

[NormannK]

there is a long list of translations waiting. But currently there are some PR's where this would conflict too much.
I'll add all suggestions here to the PR once I have the chance to commit it.

akku_soc_pro_stunde -> battery_soc_per_hour
Verluste_Pro_Stunde -> losses_per_hour
Netzeinspeisung_Wh_pro_Stunde -> grid_feed_in_wh_per_hour
Netzbezug_Wh_pro_Stunde -> grid_demand_wh_per_hour
Kosten_Euro_pro_Stunde -> cost_euro_per_hour
Gesamtkosten_Euro -> total_costs_euro
Gesamteinnahmen_Euro -> total_revenue_euro
Gesamtbilanz_Euro -> total_balance_euro
Gesamt_Verluste -> total_losses
Einnahmen_Euro_pro_Stunde -> revenue_euro_per_hour
EAuto_SoC_pro_Stunde -> ev_soc_per_hour
Last_Wh_pro_Stunde -> load_wh_per_hour
preis_euro_pro_wh_akku -> price_euro_per_wh_battery
einspeiseverguetung_euro_pro_wh -> feed_in_tariff_euro_per_wh
strompreis_euro_pro_wh -> electricity_price_euro_per_wh
pv_prognose_wh -> pv_prediction_wh
pv_akku -> pv_battery
"eauto" -> ev
"eauto_" -> ev_
"eauto$" -> ev
verluste_eauto -> ev_losses
geladene_menge_eauto -> ev_charged_amount
E-Auto -> EV;
eigenverbrauch -> internal_consumption
_akku_ -> battery
gesamtkosten_euro -> total_balance_euro
bev -> ev
Strompreis -> electricity_price_prediction
gesamtlast -> load_prediction
Gesamtlast -> Load_prediction
gesamtlast_simple -> load_prediction_simple
nebenbedingung
balance
bilanz
verluste
extra_data