Plotter accepts savedir parameter but turns it into file path

[mseitzer]

Description

Plotter has a savedir parameter for which the documentation says it specifies the directory where to save the plot to. However, the _save function interprets this parameter as a file path:

cockpit/cockpit/plotter.py

Lines 400 to 405 in 937b3ea

	file_path = (
	os.path.splitext(logpath)[0]
	+ f"__{screen}"
	+ savename_append
	+ self.save_format
	)

This means plotting with savedir='/example/path' would result in a file /example/path__primary.png, where /example/path/__primary.png would be expected.

Besides, when choosing to not display the plot, I don't think __primary or __secondary should be added to the filename. From an API standpoint, it would probably be best to let the user flexibly choose the path and filename to save to (potentially adding the image extension).

[fsschneider]

Hi,

yes, this is indeed a bit of a mess, sorry for that.

Could you have a look at the savefig_handeling branch where I tried to address this? Specifically, I now added a savename argument to the CockpitPlotter.plot function, which lets you define the name, and now the savedir should really only describe the directory.

cockpit/cockpit/plotter.py

Lines 61 to 75 in 67257a6

	def plot(
	self,
	source,
	show_plot=True,
	block=False,
	save_plot=False,
	savedir=None,
	savename="cockpit",
	savename_append=None,
	savefig_kwargs=None,
	show_log_iter=False,
	discard=None,
	plot_title=None,
	debug=False,
	):

@f-dangel Could you also have a look over my changes?

[mseitzer]

Great, this looks more convenient. I would not insist on adding the __primary string though. If the plot is not displayed anywhere, this seems to be irrelevant for the filename.

[fsschneider]

Should be solved with #16.