bsrn.visualization.cspoints.plot_csd_booklet#

bsrn.visualization.cspoints.plot_csd_booklet(file_path, output_file, station_code, df=None, title=None)[source]#

Generate a PDF: one page per day, four rows (CSD methods) x three columns (GHI, BNI, DHI). 生成 PDF：每天一页，四行（CSD 方法）× 三列（GHI、BNI、DHI）。

Clear-sky detection is driven by GHI (and each method’s required inputs). The same is_clearsky flag is overlaid on the GHI, BNI, and DHI time series in each row. 晴空检测以 GHI（及各方法所需输入）为输入；同一 is_clearsky 标记叠加到该行的 GHI、BNI、DHI 时间序列上。

Parameters:

  • file_path (str) – Path to the BSRN station-to-archive file (one month, e.g. .dat.gz). Ignored if df is provided. BSRN 站点存档文件路径（单月，如 .dat.gz）；提供 df 时忽略。

  • output_file (str) – Path to the output PDF file. 输出 PDF 路径。

  • station_code (str) – Station abbreviation (e.g. “QIQ”) for clear-sky and site location. 站点缩写（如 “QIQ”），用于晴空与站点位置。

  • df (pd.DataFrame, optional) – If provided, use this DataFrame instead of reading from file_path. Must have one-month DatetimeIndex and columns ghi, bni, dhi. 若提供，则使用此 DataFrame 而非从文件读取；须为单月且含 ghi, bni, dhi。

  • title (str, optional) – Same title on every PDF page. If None (default), no plot title. 每页共用标题；默认 None 不显示。

Returns:

Saves the booklet to the given PDF path. 将手册保存到指定 PDF。

Return type:

None