Conversion to time zone aware time series: example

[arkadiuszlis]

Add an example script

• The script description contains 2 situations found in one of the internal DBs where points were misaligned to the DB zone
• The script has a validation function which should be ran before attempting to convert ts to time zone aware
• The script fixes the situations presented in the description and converts the ts to time zone aware and back
• Add a documentation page on time zone aware ts with a reference to the example

Refers to https://github.com/Volue/energy-mesh/issues/8332

[arkadiuszlis]

Need to adjust the script to the simple thermal model, closing for now

[arkadiuszlis]

Decided to add a try-except block to mute the exception like we do in inflow and simulation examples

[martingalvan-volue]

I think this would be equivalent:

Suggested change

	if validate_points_alignment(session=session, ts_key=TS_KEYS[0]) == False:
	fix_ts_1111(session)
	convert_to_time_zone_aware(session, TS_KEYS[0])
	convert_to_time_zone_naive(session, TS_KEYS[0])
	if validate_points_alignment(session=session, ts_key=TS_KEYS[1]) == False:
	fix_ts_2222(session)
	convert_to_time_zone_aware(session, TS_KEYS[1])
	convert_to_time_zone_naive(session, TS_KEYS[1])
	fix_functions = {
	1111: fix_ts_1111,
	2222: fix_ts_2222,
	}
	for ts_key, fix_ts_points in fix_functions.items():
	if validate_points_alignment(session, ts_key) == False:
	fix_ts_points(session)
	convert_to_time_zone_aware(session, ts_key)
	convert_to_time_zone_naive(session, ts_key)

[martingalvan-volue]

I think this is simpler:

Suggested change

	aligned = True
	for timestamp in utc_time:
	if timestamp.as_py().hour != DB_ZONE_MIDNIGHT_IN_UTC:
	print(
	f"Time series key {ts_key}: the timestamp {timestamp.as_py()} is not aligned to the DB time zone midnight"
	)
	aligned = False
	break
	misaligned = next((timestamp for timestamp in utc_time if timestamp.as_py().hour != DB_ZONE_MIDNIGHT_IN_UTC), None)
	if misaligned:
	print(f"Time series key {ts_key}: the timestamp {timestamp.as_py()} is not aligned to the DB time zone midnight")
	return misaligned != None

[arkadiuszlis]

I think it's just more pythonic