"Modifying Variables" section has inconsistencies

[mdeceglie]

The Modifying Variables section of the docs (https://duramat.github.io/pv-terms/guide.html ) has some inconsistencies. The way in which to apply the preferred order is not clear. For example, temperature_module_12 and temperature_module_meas appear to apply the preferences in opposite order.

[toddkarin]

Good point. I'll make this more consistent.

[mdeceglie]

This may be related to #17... Perhaps allowing suffixes while some parameter names already include the suffixes (e.g. temperature_module) causes inconsistencies?

[toddkarin]

What do you think about this slightly changed order of modifications:

--
Many variables can be directly used without modification. However, there are many cases where the standard set of variables does not cover a particular application. For this reason, we have provided a list of :ref:optional suffixes<optional_suffixes> that can be appended to a variable name.

For example, one application might be to compare simulated and measured maximum-power-point power. In this case, the base variable pmp can be modified into pmp_sim and pmp_meas.

In order to standardize some common naming modifications, we have chosen a common order.

1. _cell, _module, _string, _array, _inv.
2. _XX, where XX is the name of the particular system.
3. _rated, _sim, _meas
4. _interval, _cumulative

For simplicity, it is not necessary to use all modifications for a particular variable.

Some examples:

• temperature_module_12 Module temperature sensor 12.
• current_dc_inv_2132: dc-side current from inverter 2132.
• temperature_module_meas, temperature_module_sim: measured and simulated module temperature respectively.
• beta_voc_module, beta_voc_string: beta_voc for a module and a string respectively.
• alpha_isc_module_rated, alpha_isc_module_meas: rated and measured module alpha_isc.
• energy_real_inv_12_sim_interval real energy for inverter 12 simulated on a specified interval.

[mdeceglie]

I think this is now consistent. From a parsing perspective, it may be simpler to always have _XX be the final thing. However, that would make the already unwieldy energy_real_inv_12_sim_interval even less readable "Energy real inverter simulated interval 12" What do folks think.

[toddkarin]

My idea was to place _XX directly after e.g. _string because the number typically directly modifies the item _string.