Skip to content

Commit f057684

Browse files
committed
Add output_memory_usage to configutation documentation
1 parent 4423e63 commit f057684

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/configuration.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,12 @@ The Micro Manager is configured with a JSON file. An example configuration file
3030

3131
This example configuration file is in [`examples/micro-manager-config.json`](https://github.com/precice/micro-manager/tree/develop/examples/micro-manager-config.json).
3232

33-
The path to the file containing the Python importable micro simulation class is specified in the `micro_file_name` parameter. If the file is not in the working directory, give the relative path.
33+
The path to the file containing the Python importable micro simulation class is specified in the `micro_file_name` parameter. If the file is not in the working directory, give the relative path from the directory where the Micro Manager is executed.
3434

3535
Set the output [log](tooling-micro-manager-logging.html) directory using the parameter `output_dir`.
3636

37+
To output the runtime memory usage, set `output_memory_usage` to `True`. This will output a CSV file with the peak memory usage (RSS) in every time window, in MBs.
38+
3739
There are three main sections in the configuration file, the `coupling_params`, the `simulation_params` and the optional `diagnostics`.
3840

3941
## Coupling Parameters

0 commit comments

Comments
 (0)