コンテンツにスキップ

4. Open OnDemand の使い方

Open OnDemand の使い方について説明します。

画面上部のメニューバーの使い方について説明します。

4.1.1. ファイル操作

メニューバーの Files から Home Directory を選択すると、TSUBAMEのホームディレクトリが表示されます。

画面上のボタンから、基本的なファイル操作が行えます。

ボタン 操作 説明
Open in Terminal ターミナル 新しいタブで TSUBAME のターミナルを開く
Refresh リフレッシュ 再描画
New File ファイル作成 新規ファイル作成
New Directory ディレクトリ作成 新規ディレクトリ作成
Upload アップロード ファイルのアップロード
Download ダウンロード リストから選択したファイルのダウンロード
Copy/Move コピー/移動 リストから選択したファイルのコピー、移動
Delete 削除 リストから選択したファイルの削除
Change directry ディレクトリ移動 ディレクトリの移動
↑ ペアレントディレクトリ移動 ひとつ上のディレクトリに移動
Copy path パスコピー カレントディレクトリのパスをコピー

4.1.2. TSUBAMEへのログイン

Clusters > TSUBAME cluster Shell Access を押すと、TSUBAME にターミナルでログインすることができます。ターミナルは複数開くことができます。

TSUBAME からログアウトしてターミナルを終了するには、exit を入力し、ブラウザのタブを閉じてください。

Tips

ターミナルは一定時間入力がないと、自動的に切断されます。回避方法はこちらをご覧下さい。 TSUBAME4で作業中にセッションが切れてしまいます

4.1.3. Interactive Apps

Interactive Apps の使い方については、3.2. Interactive Apps をご覧下さい。

4.1.4. セッション管理

My Interactive Sessions では、自分のセッションを表示することができます。

各セッションの Delete を押すと、セッションを終了することができます。

Tips

ブラウザの幅が狭くなると、メニューバーの My Interactive Sessions の文字列がなくなり、アイコン表示だけになります。

4.1.5. ヘルプとリスタート

Help を押すと、マニュアル表示とリフレッシュができます。

Open OnDemand に不具合がある場合は、まず Restart Web Server を試してみてください。

Access Management Page からアクセス管理サーバへのログイン が出来ます。

4.1.6. ログアウト

Open OnDemand からログアウトするには、メニューバーの Log Out を押してください。

Warnning

Log Out を押さずにブラウザを閉じてしまうと、Open OnDemand のセッションが一定時間残り続けます。この場合、再度 Open OnDemand にログインしようとした際に不具合が発生する恐れがあります。Open OnDemand を終了する際は、必ず Log Out を押してください。

4.2. Interactive Apps

TSUBAME4.0のOpen OnDemandでは、以下の3つのInteractive Appsが利用可能です。

  • TSUBAME Desktop (xfce)
  • Jupyter
  • code server

各Interactive Appsは、実行タイプによって更に2種類に別れます。

  • 通常の計算ノードを利用（従量・予約）
  • インタラクティブジョブ専用キューを利用(※ 名称に interactive が含まれています )

実行タイプによる差異は以下の通りです。

実行タイプ 通常の計算ノードを利用 インタラクティブジョブ専用キューを利用
利用形態 有償 学内無償・その他 有償
資源タイプ 指定可能 インタラクティブジョブ専用キュー (物理CPUコア数 24コア, 96GBメモリ, 1MIG(GPU数 1/2)の資源を最大12名で共有利用します。 )
利用ノード数 指定可能 1ノード固定
優先度指定 可 不可
予約 可 不可

以下に、Interactive Apps の利用手順を示します。

Info

本利用手順で紹介するスクリーンショットは基本的にTSUBAME Desktop (xfce)使用時のものです。
アプリケーションによる設定内容の違いはないため、適宜読み替えてください。

4.2.1. アプリケーション・実行タイプの選択

画面中央下のPinned Apps から、利用したいアプリのアイコンをクリックします。

利用環境の設定画面に移動します。

4.2.2. 利用環境の設定

利用環境項目を設定し、Launch ボタンを押下します。リクエストがジョブとして投入されます。

項目名 項目 説明
Select resouce type 資源タイプ 希望の資源タイプを選択します
Number of Request resources 資源数 希望のノード数
TSUBAME group グループ TSUBAMEグループを指定します
Maximum run time(hh:mm:ss) 使用時間 予定の使用時間を最大値で設定（途中終了可）
Priority Option 優先度 優先度を指定する
Reservation Number (AR ID) 予約番号 予約を使用して実行する場合は予約番号(AR ID)を指定

Info

インタラクティブジョブ専用キューを利用する場合、「TSUBAME group」および「Maximum run time」のみ設定可能です。

Info

インタラクティブジョブ専用キューは、学内ユーザ(tgz-edu)とアクセスカードユーザに限り無償で実行可能です。
無償利用する場合、「TSUBAME group」に「Free」を指定してください。
グループを指定した場合、対象グループに対して課金が発生しますのでご注意ください。

Info

予約が使用できる資源タイプは、node_f, node_h, node_q, node_o のみです。

4.2.3. アプリケーションの起動

リクエストはジョブとして投入され、指定したリソースが割り当てられるとセッションが Running になります。Queued の場合は、実行待ちですので、しばらく待ってから状態を確認して下さい。

セッションが Running になったら、「Launch アプリ名」をクリックするとアプリケーションが起動します。

Info

「Compression」「Image Quality」はTSUBAME Desktopでのみ表示されます。

Info

View Only (Share-able Link) を押すと、新しいタブで X のデスクトップのコピーが開きます。
画面操作はできませんが、先ほどのデスクトップがミラーリング表示されます。このタブのURLをメール等で送信することで、簡易的に画面共有やモニタをすることができます。

Warning

OpenOnDemandでは、アプリケーション非利用時でもセッションが有効な限り計算資源が確保されTSUBAMEポイントの課金対象となります。
資源の有効活用の観点からも、アプリケーションの利用終了後は手動でセッションの削除を実施してください。

以下に、各アプリケーションの初期画面を示します(実行タイプによる差異はありません)。 利用方法などについては各公式サイトをご参照ください。

4.2.3.1. Jupyter(ipykernel)上に仮想環境を登録する

Jupyterで利用可能なkernel(ipykernel)上では、module loadを実施することが出来ません。
本問題を解決するために、必要なモジュールをロードした仮想環境を作成・登録する方法を紹介します。

Info

本稿の内容は Jupyterlab 4.1.4 / CUDA 12.8.0 / python 3.9.18 の組み合わせで検証しています。

4.2.3.1.1. モジュールをロードした仮想環境の作成

モジュールをロードした仮想環境の作成手順を以下に示します。

Info

OpenOnDemandのJupyterのTerminalを使用した場合、ログイン時に jupyterlab 等のモジュールがロードされています。 必ずmodule purge コマンドを実行してから仮想環境を作成してください。

本項の実行例では仮想環境の名称( virtual_environment_name )を仮に env01 としています。任意の名前に変更可能です。

1.空の仮想環境を作成・アクティベートする 

[login/rNnN]$ module purge
[login/rNnN]$ python -m venv virtual_environment_name         # virtual_environment_nameは自身の仮想環境名に置き換え
[login/rNnN]$ source virtual_environment_name/bin/activate    # virtual_environment_nameは自身の仮想環境名に置き換え

<実行例>

[tsubame_user@r8n10 ~]$ cd ~
[tsubame_user@r8n10 ~]$ module purge
[tsubame_user@r8n10 ~]$ python -m venv env01
[tsubame_user@r8n10 ~]$ source env01/bin/activate  
(env01) [tsubame_user@r8n10 ~]$

Info

仮想環境のアクティベート後は、指定した仮想環境名がプロンプトに表示されます。

この状態で、仮想環境へのpip / module load 等を使用したパッケージ追加、モジュールロード等が可能となります。

なお、仮想環境から抜ける場合は deactivate コマンドを実行します。

<実行例>

(env01) [tsubame_user@r8n10 ~]$ deactivate 
[tsubame_user@r8n10 ~]$

2.必要なモジュールをロードする

作成した仮想環境内でモジュールをロードします。
ここでは例として、GPUなどを使用するためにCUDAのモジュールをロードします。

[virtual_environment]$ module load cuda/12.8.0

<実行例>

(env01) [tsubame_user@r8n10 ~]$ module load cuda/12.8.0
(env01) [tsubame_user@r8n10 ~]$ module list
Currently Loaded Modulefiles:
 1) cuda/12.8.0  

Key:
default-version

4.2.3.1.2. Jupyter(ipykernel)への仮想環境の登録手順

Info

本項の実行例では仮想環境の名称( virtual_environment_name )を仮に env01 としています。任意の名前に変更可能です。

専用のツール(t4jpyregister)を使用して、モジュールをロードした仮想環境の作成手順で作成した仮想環境を登録します。 

[virtual_environment]$ /apps/t4/rhel9/utils/bin/t4jpyregister -n virtual_environment_name    # virtual_environment_nameは自身の仮想環境名に置き換え

<実行例> 

(env01) [tsubame_user@r8n10 ~]$ /apps/t4/rhel9/utils/bin/t4jpyregister -n env01
INSTALL TO ${HOME}/.local/share/jupyter/kernels/env01

JupyterのLauncher画面上で、env01が追加されていることが確認できます(赤枠部分。反映には多少時間がかかります)。

コマンドラインで確認する場合はjupyterlabのモジュールをロード後に以下のコマンドを実行します。

Info

仮想環境から抜けた(ディアクティベートした)状態で実行してください。 

[login/rNnN]$ module load jupyterlab/4.1.4
[login/rNnN]$ jupyter kernelspec list

<実行例> 

[tsubame_user@r8n10 ~]$ module load jupyterlab/4.1.4
[tsubame_user@r8n10 ~]$ jupyter kernelspec list
Available kernels:
  env01      ${HOME}/.local/share/jupyter/kernels/env01
  python3    /apps/t4/rhel9/free/jupyterlab/4.1.4/gcc11.4.1/python3.9.18_b/share/jupyter/kernels/python3

4.2.3.1.3. 登録した仮想環境をJupyterから削除

登録した仮想環境をJupyterから削除する場合、jupyterlabのモジュールをロード後に以下のコマンドを実行します。
削除して良いか確認が出るので y を押してください。

Info

仮想環境ファイル自体は削除されません。
仮想環境から抜けた(ディアクティベートした)状態で実行してください。 

[login/rNnN]$ module load jupyterlab/4.1.4
[login/rNnN]$ jupyter kernelspec uninstall virtual_environment_name    # virtual_environment_nameは自身の仮想環境名に置き換え

<実行例> 

[tsubame_user@r8n10 ~]$ jupyter kernelspec uninstall env01
Kernel specs to remove:
  env01                 ${HOME}/.local/share/jupyter/kernels/env01
Remove 1 kernel specs [y/N]: y
Removed ${HOME}/.local/share/jupyter/kernels/env01

JupyterのLauncher画面上から、env01が削除されました。

4.2.4. セッションの削除

各アプリケーションを終了する場合、ブラウザの該当タブを閉じ、セッション一覧から該当セッションを Delete します。
終了すると、このセッションは Completed になります。また、指定した使用時間を経過した場合も Completed になります。
Completed になったセッションは一定期間後に自動的に一覧から削除されます。