monteCarloSimulationSummarizer

The Monte Carlo Simulation Summarizer (MCSS) is a tool to summarize results of random simulation.

---

GitHub: https://github.com/YujiSODE/monteCarloSimulationSummarizer

Copyright (c) 2023 Yuji SODE <yuji.sode@gmail.com>
This software is released under the MIT License.
See LICENSE or http://opensource.org/licenses/mit-license.php

---

Synopsis

This tool generates a new directory, where to output three results and some additional sources.

Three main results to output

• ${outputName}_MCSS[numbers]_LOG.md: log in Markdown file
• ${outputName}_MCSS[numbers]_INFO.csv: summarized information in CSV file
• ${outputName}_MCSS[numbers]_DATA.csv: frequency distribution in CSV file

Interfaces

There are two input interfaces (shell input and script input).

1. shell input: MCSS_INPUT.tcl

MCSS_INPUT.tcl splitChar formatString values ?values ... values?
or
tclsh MCSS_INPUT.tcl splitChar formatString values ?values ... values?

Arguments for shell input

• $splitChars: characters that are used to split each value of $values
• $formatString: a format string using % conversion specifiers (e.g., %.4f). See format
• $values: values that are joined by $splitChars (e.g., "value@value@...@value", which is joined by @)

The above commands generates a new directory, where to output results.

2. script input: using a template file that is generated by MCSS_TEMPLATE_GEN.tcl

2-1. Template file

tclsh MCSS_TEMPLATE_GEN.tcl name
or
MCSS_TEMPLATE_GEN.tcl name

Arguments to generate template file

• $name : a name for a template file

The above commands generates a new template file named "${name}_TEMP.tcl". See _example_TEMP.tcl.

2-2. Generated template file

Commands in monteCarloSimulationSummarizer.tcl and Tcl script is available in this output template file.
See Sample files.
This template file generates a new directory, where to output results.

Scripts

• monteCarloSimulationSummarizer.tcl: main script
• MCSS_INPUT.tcl: shell interface for the MCSS.
• MCSS_TEMPLATE_GEN.tcl: shell interface of template generator for the MCSS.
• tsvReader.tcl: TSV Reader that loads the first two columnar contents as xy data.

Library

• Sode, Y. 2023. majorSign/majorSign.tcl, the MIT License: https://github.com/YujiSODE/majorSign
• Sode, Y. 2018. lSum.tcl: https://gist.github.com/YujiSODE/1f9a4e2729212691972b196a76ba9bd0

Compatibility

• Tcl 8.6+