citylearn.exporter module

class citylearn.exporter.EpisodeExporter(env: CityLearnEnv)

Bases: object

Internal helper that owns rendering/export behaviour for CityLearnEnv.

DEFAULT_RENDER_START_DATE = datetime.date(2024, 1, 1)

ensure_output_dir(*, ensure_exists: bool = True)

Prepare the render output directory and optionally create it on disk.

export_business_as_usual_timeseries(source_env: CityLearnEnv = None)

Export a compact time-series audit for the business-as-usual baseline.

export_episode_render_data(final_index: int)

Export full episode render rows in one pass for render_mode='end'.

export_final_kpis(model: Agent = None, filepath: str = 'exported_kpis.csv', include_business_as_usual: bool = True, export_business_as_usual_timeseries: bool = True, kpi_round_decimals: int | None = None)

Export episode KPIs to csv.

flush_render_buffer()

Write any buffered render rows to disk.

get_iso_timestamp() → str

Return current episode timestamp string in ISO format.

override_render_time_step(index: int)

Temporarily set time_step to index for the environment and descendants.

static parse_render_start_date(start_date: str | date | datetime) → date

Return a valid start date for rendering timestamps.

render()

Render one time step to configured time-series outputs.

reset_time_tracking()

Reset render timestamp tracking to episode start.

static restore_render_time_step(snapshot)

save_to_csv(filename: str, data: Mapping[str, Any])

Save one render row to configured output format.

write_render_rows(filename: str, rows: List[Mapping[str, Any]])

Write one or more render rows to disk with minimal rewrites.