Skip to content

Commit db09a87

Browse files
Update README.md to include instructions for generating ESMF profiling log files
1 parent 5fdbfdb commit db09a87

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

ESMF_profiling/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,13 @@ The tool supports two profiling data formats, where metrics are included in the
2222
2. `ESMF_Profile.summary`: (0. count, 1. PETs , 2. mean , 3. min_time, 4. max_time, 5. min_PET, 6. max_PET)
2323

2424
## Usage
25-
Simply specify the path to the profiling logs, along with any specific regions of interest.
25+
Before using the scripts, ensure that ESMF profiling log files are generated first. To enable profiling, simply set the `ESMF_RUNTIME_PROFILE` and `ESMF_RUNTIME_PROFILE_OUTPUT` options in the `config.yaml` file for the desired configuration:
26+
```yaml
27+
env:
28+
ESMF_RUNTIME_PROFILE: "ON"
29+
ESMF_RUNTIME_PROFILE_OUTPUT: "TEXT SUMMARY"
30+
```
31+
After running the configuration, specify the path to the profiling logs, along with any specific regions of interest.
2632
2733
One example for demonstration:
2834
----------

0 commit comments

Comments
 (0)