Multiparser is module for performing functionality across a set of output files. Given a set of files, and optionally a list of output parameter names or regex filters the module keeps track of changes by monitoring the "last modified" timestamp of each file and executing the assigned callback.
For example, in the case where a set of model outputs were written to a set of files the user is able to specify which files are of importance, the variables to be noted within these files, and a function to execute whenever a change is made to one of these files.
The module is available in PyPi:
pip install ukaea-multiparserTo install optional extras arrow and fortran list them during the install, e.g.:
pip install ukaea-multiparser[fortran,arrow]with FileMonitor(
per_thread_callback=callback_function,
lock_callback=True,
interval=10.0,
flatten_data=True
) as monitor:
monitor.track(
path_glob_exprs=["file_of_interest.toml", "out_dir/*.other"],
tracked_values=[
"list", "of", "interesting", "values",
re.compile(r"^list"),
re.compile(r"of\s"),
re.compile(r"regular"),
re.compile(r"Expressions")
],
static=True
)
monitor.run()
...
monitor.terminate()For information on use and functionality please see the documentation.
Multiparser is provided under the MIT license allowing reuse within both open source and proprietary software.
For contributions and development towards improving Multiparser please see the included CONTRIBUTING.md file.
Copyright (c) 2024 UK Atomic Energy Authority