Skip to content

Commit f366c71

Browse files
cailmdaleyclaude
andcommitted
docs(canfar): monitoring section points at canfar_monitor entry point
The documented curl_canfar_monitor.sh never existed under that name (the script was curl_canfar_monitor_local.sh, removed in this PR); the python canfar_monitor entry point supersedes it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 898a1de commit f366c71

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

docs/source/canfar.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,15 @@ it is recommended to perform some or all of the testing steps (1. - 4.).
5959

6060
### Status and output of submitted job
6161

62-
Monitoring of the currently active remote session can be performed using the session IDs `session_IDs.txt` written by the
63-
remote session script `curl_canfar_local.sh`. In the patch main directory, run
62+
Monitoring of the currently active remote session uses the session IDs in `session_IDs.txt` written by the
63+
remote session script `curl_canfar_local.sh`. In the patch main directory, run the `canfar_monitor` entry point
64+
(installed with the package; see `[project.scripts]` in `pyproject.toml`)
6465
```bash
65-
curl_canfar_monitor.sh events
66+
canfar_monitor events
6667
```
6768
to display the remotely started docker image status, and
6869
```bash
69-
curl_canfar_monitor.sh logs
70+
canfar_monitor logs
7071
```
7172
to print `stdout` of the remotely run pipeline script.
7273

0 commit comments

Comments
 (0)