v1.4.0

This release brings about 3 major new features:

• Ability to extract run metadata from a "phits.out" file with the new parse_phitsout_file() function.
  • This includes information such as the PHITS version number, the PHITS input echo, memory usage, run start/stop time, CPU time, the citation request section (saying what extra papers should be cited for that run's results), etc.
• Ability to merge all tally_output dictionaries produced by a call of parse_all_tally_output_in_dir() into a single merged dictionary object.
  • A separate toggle for choosing to save this merged file has been added, allowing for saving of only the merged tally outputs rather than requiring all individual tally output .pickle files be saved too.
• [INPUT_FILE mode] in parse_all_tally_output_in_dir(), allowing one to process all tally outputs from active tallies (i.e., not commented out or turned off) listed in a PHITS input file (or its produced phits.out file).
  • Together with the phits.out processing and merging of outputs from this function, this means all processed output from a single PHITS run, their metadata, metadata about the run itself, and the PHITS input producing all of these results can be stored together in a single object / saved to a single .pickle file.

These new features are accessible across all usages of PHITS Tools, as an imported module or via its CLI/GUI.

With these new functionalities, PHITS Tools is now capable of automatically processing all output produced by a single PHITS run together provided the PHITS input file. This means that PHITS Tools can be used, via its CLI, in the phits.bat/phits.sh scripts to automatically process all of the outputs of a PHITS run every time PHITS is executed via its shell/batch script. See the newly added "Automatic processing at PHITS runtime" section in README.md for more information about how to set this up and how it works.

In more explicit terms, this release brings the following changes:

• 2 new functions:
  • parse_phitsout_file()
  • extract_tally_outputs_from_phits_input()
• New input argument include_phitsout_in_metadata added to parse_tally_output_file()
• New input arguments include_phitsout_in_metadata, merge_tally_outputs, and save_pickle_of_merged_tally_outputs added to parse_all_tally_output_in_dir()
  • The default behavior of output_file_suffix has changed slightly. It remains '.out' if the function is provided a directory, but the default is '' if the function is provided a PHITS input file or phits.out file.
  • See documentation for parse_all_tally_output_in_dir() for updated output behavior relevant to usage of the new input arguments. (Default behavior remains unchanged.)