gemseo.utils.xdsm_to_pdf module#

Provide routines for XDSM and tikz.

class XDSMToPDFConverter[source]#

Bases: object

Convert an XDSM to a PDF file with tikz and latex.

convert(xdsm_data, directory_path, file_name, scenario, build=True, cleanup=True, batchmode=True)[source]#

Convert a dictionary representation of a XDSM into a pdf.

Parameters:

  • xdsm_data (dict[str, Any]) -- The XDSM representation.

  • directory_path (Path) -- The path to the output directory where the pdf is generated.

  • file_name (str) -- The name of the output file.

  • scenario (str) -- The name of the scenario.

  • build (bool) --

    Whether the standalone pdf of the XDSM will be built.

    By default it is set to True.

  • cleanup (bool) --

    Whether the intermediate files (file_name.tex, file_name.tikz and built files) will be cleaned up after the PDF is created.

    By default it is set to True.

  • batchmode (bool) --

    Whether pdflatex is run in batchmode.

    By default it is set to True.

Return type:

None

xdsm_data_to_pdf(xdsm_data, directory_path, file_name='xdsm', scenario='root', pdf_build=True, pdf_cleanup=True, pdf_batchmode=True)[source]#

Convert a dictionary representation of a XDSM to a pdf.

Parameters:

  • xdsm_data (dict[str, Any]) -- The XDSM representation.

  • directory_path (Path) -- The output directory where the pdf is generated.

  • file_name (str) --

    The output file name (without extension).

    By default it is set to "xdsm".

  • scenario (str) --

    The name of the scenario name.

    By default it is set to "root".

  • pdf_build (bool) --

    Whether the standalone PDF of the XDSM will be built.

    By default it is set to True.

  • pdf_cleanup (bool) --

    Whether intermediate files (file_name.tex, file_name.tikz and built files) will be cleaned up after build is complete.

    By default it is set to True.

  • pdf_batchmode (bool) --

    Whether pdflatex is run in batchmode.

    By default it is set to True.

Return type:

None