Hermes-3 is a multifluid plasma simulation model for transport and turbulence in the edge of magnetically confined plasmas. The physical system are defined in its input file BOUT.inp through various keywords and inputs. hermes2tex first define the meaning of each keywords in YAML files (hermes2tex/include), combine them together as a physical system, and render a LeTeX file (hermes2tex/templates) based on the physical system.
Be aware that this tool is still in its early stages of development, and the generated document may contain inaccuracies or omissions. For more accurate and detailed information, please refer to the original Hermes-3 documentation or source code.
First clone the project from github:
git clone https://github.com/yichenfu/hermes2tex.git
Then install with pip:
pip install -e .
For any hermes-3 input file, we can load the input file and see its physical system using
import hermes2tex as ht
physical_system = ht.PhysicalSystem.load(input_file="Path_to_hermes3_input")
physical_system.get_detail()A LaTeXed document can be generated using
latex_render = ht.LatexRenderer(physical_system = physical_system)
latex_render.render(save_dir="Path_to_save_latex_file", compile=True)More examples can be found in example/ and test/subdirectories.