Commit 6cbd183c authored by Hendryk Bockelmann's avatar Hendryk Bockelmann
Browse files

some more docu for html doxygen website

parent d46ad36a
......@@ -6,7 +6,7 @@
\copyright Copyright (C) 2017 Joerg Behrens <behrens@dkrz.de>, Hendryk Bockelmann <bockelmann@dkrz.de>
\section License
\section control License
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
......@@ -92,14 +92,35 @@ make install
\endcode
You can also specify several configure options, try --help for all details.
\section control Controling the output by environment variables
- recording of eventcounters (if sct is installed with PAPI support)
- SCT_EVENTCOUNTERS = [0 | 1 | 2] (default: 1) show counter results either as absolute values (1) or as rates per second (2)
- SCT_EVENT_LIST: list of PAPI (or system specific) events to be recorded
- extended (showing statistics for each timer) or simple (showing only total sum for each timer) listing
- SCT_CALLSTATS = [0 | 1] (default: 0)
- simple bookkeeping of timer hierarchy
- SCT_NESTEDTIMERS = [0 | 1] (default: 0)
\section control Controlling the output by environment variables
We support writing the measured timers to
- stdout
- ASCII file
- hdf5 file
Please use the folowwing envVars to control the output location:
- SCT_OUT = [stdout | stderr | hdf5] (default: stdout)
- SCT_FILENAME = \<filename\>
Reduction of timer results over several MPI-tasks and/or OpenMP-threads (showing min/max/avg) or complete output is done via
- SCT_PROC_CHOICE = [SCT_SELECT_ALL | SCT_REDUCE_ALL | \<proc_id\>]
- SCT_THREAD_CHOICE = [SCT_SELECT_ALL | SCT_REDUCE_ALL | \<thread_id\>]
Combining serial phase measurement and parallel phase measurement (this only matters for OpenMP): SCT_SP_MERGING =
- SCT_SP_SERIAL_ONLY: only the serial phase measurement is used
- SCT_SP_PARALLEL_ONLY: only the thread-parallel measurement is used
- SCT_SP_MERGE_SIMPLE: the serial phase measurement is added to the master thread of parallel regions
- SCT_SP_SELECT_ALL: the serial phase measurement and the thread-parallel measurement are reported separately
Recording of eventcounters (if sct is installed with PAPI support)
- SCT_EVENTCOUNTERS = [0 | 1 | 2] (default: 1) show counter results either as absolute values (1) or as rates per second (2)
- SCT_EVENT_LIST: list of PAPI (or system specific) events to be recorded
Extended (showing statistics for each timer) or simple (showing only total sum for each timer) listing
- SCT_CALLSTATS = [0 | 1] (default: 0)
Simple bookkeeping of timer hierarchy
- SCT_NESTEDTIMERS = [0 | 1] (default: 0)
timer have to be nested correctly, hence this is not allowed:
\code
sct_start(A);
......@@ -110,17 +131,6 @@ sct_start(B);
sct_stop(A);
sct_stop(B)
\endcode
- reduction of timer results over several MPI-tasks and/or OpenMP-threads (showing min/max/avg) or complete output
- SCT_PROC_CHOICE = [SCT_SELECT_ALL | SCT_REDUCE_ALL | \<proc_id\>]
- SCT_THREAD_CHOICE = [SCT_SELECT_ALL | SCT_REDUCE_ALL | \<thread_id\>]
- combining serial phase measurement and parallel phase measurement (this only matters for OpenMP): SCT_SP_MERGING =
- SCT_SP_SERIAL_ONLY: only the serial phase measurement is used
- SCT_SP_PARALLEL_ONLY: only the thread-parallel measurement is used
- SCT_SP_MERGE_SIMPLE: the serial phase measurement is added to the master thread of parallel regions
- SCT_SP_SELECT_ALL: the serial phase measurement and the thread-parallel measurement are reported separately
- setting the output
- SCT_OUT = [stdout | stderr | hdf5] (default: stdout)
- SCT_FILENAME = \<filename\>
<HR>
*/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment