upxo.pxtal.twinned_simple_3d.steps.steps_start module
Start / Global Configuration – Part A of the Twinned FCC walkthrough.
Picks the pipeline-wide output directory and opens the upxo.reporting.ReportSession every later stage appends its key results into. Every later steps_*.py function that takes a report argument appends to the SAME session object returned here, so the notebook ends up with one report.html covering the whole run.
- upxo.pxtal.twinned_simple_3d.steps.steps_start.open_pipeline_report(output_dir=PosixPath('/home/runner/work/UPXO/UPXO/data'), researcher_name='', organisation='', email='', material_name='', processing_condition='', notebook_tag=None)[source]
Opens (or resumes) this run’s report session under <output_dir>/TwinnedFCC/Reports – the same “<output base>/TwinnedFCC/<category>” layout used for every other output category (raw exports, mesh files, …) this walkthrough writes.
researcher_name/organisation/email/material_name/processing_condition are optional run-metadata fields – all blank by default, shown once at the top of the generated report.html.
notebook_tag: when multiple notebooks (e.g. a basic/intermediate/advanced tier) share this same steps/ package, pass a short tag (e.g. ‘bas0’, ‘int0’, ‘adv0’) so each gets its own <Reports>/<tag>/report.html instead of all of them accumulating into one shared report.
- Return type: