Skip to content

Commit 693cbff

Browse files
author
OutlyingWest
committed
vampir launch control commands documented; logging chapter moved to Usage
1 parent 3c24d57 commit 693cbff

1 file changed

Lines changed: 34 additions & 18 deletions

File tree

README.md

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,14 @@ For binding to Score-P, the kernel uses the [Score-P Python bindings](https://gi
2929
- [Usage](#usage)
3030
- [Score-P Instrumentation](#score-p-instrumentation)
3131
- [Configuring Score-P in Jupyter](#configuring-score-p-in-jupyter)
32+
- [Vampir Launch Control](#vampir-launch-control)
3233
- [Multi-Cell Mode](#multi-cell-mode)
3334
- [Write Mode](#write-mode)
35+
- [Logging Configuration](#logging-configuration)
3436
- [Presentation of Performance Data](#presentation-of-performance-data)
3537
- [Limitations](#limitations)
3638
- [Serialization Type Support](#serialization-type-support)
3739
- [Overhead](#overhead)
38-
- [Logging Configuration](#logging-configuration)
3940
- [Future Work](#future-work)
4041
- [Citing](#citing)
4142
- [Contact](#contact)
@@ -131,7 +132,22 @@ Executes a cell with Score-P, i.e. it calls `python -m scorep <cell code>`
131132

132133
![](doc/instrumentation.gif)
133134

135+
### Vampir Launch Control
136+
137+
To automatically launch **Vampir** after a cell with Score-P instrumentation, use:
138+
139+
```
140+
%%enable_vampir_launch_on_scorep_instrumented
141+
```
134142

143+
This will cause the kernel to open `traces.otf2` in Vampir (if found) after the next instrumented cell.
144+
To disable this behavior again:
145+
146+
```
147+
%%disable_vampir_launch
148+
```
149+
150+
By default, Vampir launching is disabled. You must enable it explicitly when needed.
135151

136152
## Multi-Cell Mode
137153
You can also treat multiple cells as one single cell by using the multi cell mode. Therefore you can mark the cells in the order you wish to execute them.
@@ -186,6 +202,23 @@ Stops the marking process and writes the marked cells in a Python script. Additi
186202

187203
![](doc/writemode.gif)
188204

205+
## Logging Configuration
206+
To adjust logging and obtain more detailed output about the behavior of the scorep_jupyter kernel, refer to the `src/logging_config.py` file.
207+
This file contains configuration options for controlling the verbosity, format, and destination of log messages. You can customize it to suit your debugging needs.
208+
209+
Log files are stored in the following directory:
210+
```
211+
scorep_jupyter_kernel_python/
212+
├── logs_scorep_jupyter/
213+
│ ├── debug.log
214+
│ ├── info.log
215+
└── └── error.log
216+
```
217+
In some cases, you may want to suppress tqdm messages that are saved to error.log (since tqdm outputs to stderr). This can be done using the following environment variable:
218+
```
219+
%env TQDM_DISABLE=1
220+
```
221+
189222

190223
# Presentation of Performance Data
191224

@@ -205,23 +238,6 @@ Similar yields for cloudpickle. Use the `%%marshalling_settings` magic command t
205238

206239
When dealing with big data structures, there might be a big runtime overhead at the beginning and the end of a Score-P cell. This is due to additional data saving and loading processes for persistency in the background. However this does not affect the actual user code and the Score-P measurements.
207240

208-
## Logging Configuration
209-
To adjust logging and obtain more detailed output about the behavior of the scorep_jupyter kernel, refer to the `src/logging_config.py` file.
210-
This file contains configuration options for controlling the verbosity, format, and destination of log messages. You can customize it to suit your debugging needs.
211-
212-
Log files are stored in the following directory:
213-
```
214-
scorep_jupyter_kernel_python/
215-
├── logs_scorep_jupyter/
216-
│ ├── debug.log
217-
│ ├── info.log
218-
└── └── error.log
219-
```
220-
In some cases, you may want to suppress tqdm messages that are saved to error.log (since tqdm outputs to stderr). This can be done using the following environment variable:
221-
```
222-
%env TQDM_DISABLE=1
223-
```
224-
225241
# Future Work
226242

227243
The kernel is still under development.

0 commit comments

Comments
 (0)