7. CCMS JupyterLab 操作マニュアル

7.1. 環境接続手順

CCMS JupyterLabに接続する際には、SSHポートフォワーディングを使用します。以下の手順に従って設定を行ってください。

・前提条件

フロントエンドサーバ上で稼働しているCCMS JupyterLabの待ち受けポートは、ポート番号28000です。 本マニュアルでは、以下のようなSSHポートフォワーディングを設定した前提で操作方法を記載しています。

・SSHポートフォワーディングの設定

以下を ~/.ssh/configに記載して、localhostのポート番号20080/20081からsuper2/super3のポート番号28000への通信を転送します。

$ cat ~/.ssh/config
Host cms-ssh.sc.imr.tohoku.ac.jp
    User username
    HostName cms-ssh.sc.imr.tohoku.ac.jp
    IdentityFile ~/.ssh/keys/id_rsa

Host ccms-jupyter
    User username
    HostName super.sc.imr.tohoku.ac.jp
    ProxyJump cms-ssh.sc.imr.tohoku.ac.jp
    LocalForward 20080 super2.sc.imr.tohoku.ac.jp:28000
    LocalForward 20081 super3.sc.imr.tohoku.ac.jp:28000

$ ssh ccms-jupyter

※ ~/.ssh/keys/id_rsa はご自身の秘密鍵をご指定ください。

※ usernameはご自身のアカウント名をご指定ください。

※ localhostのポート番号20080/20081は必要に応じて修正いただけます。

以降の各操作手順は、このポートフォワーディングが設定されていることを前提としています。

7.2. ログイン方法

以下の URL に接続するとログイン画面が表示され、スパコンシステムアカウントの ID/PW でログインできます。

URL： http://localhost:20080/　　※20080 はポートフォワードで設定したポート番号で置換

../_images/JupyterLab_1.jpg

7.3. JupyterLab 操作方法

ログイン後のトップ画面にあるリンクから各機能が利用できます。

　Notebook ： Jupyter Notebook の利用が可能です。

　Terminal ： シェル操作による OS（Ubuntu）の利用が可能です。

../_images/JupyterLab_2.jpg

JupyterLab の各機能の操作全般は公式ドキュメントに記載されています。

JupyterLab 公式ドキュメント

7.4. Conda 環境作成方法

conda 仮想環境の操作はJupyterLab 内の Terminal 機能から実施します。

・準備

$ conda init

※ conda 環境の初期設定であり、初回のみ実行が必要。

・作成

$ conda create -n SampleEnv python=3.11.5 ipython ipykernel

※ SampleEnv という名称の仮想環境を作成。末尾にパッケージを指定可能。

※ SampleEnv の文字列は任意の文字列に変更。

※ JupyterLab のカーネル登録時に必要となるため ipython、ipykernel は指定が必要。

・表示

$ conda info -e

※ 表示されるパスが /opt/conda/... で始まる環境はシステム領域にある環境。

※ 表示されるパスが /home/... で始まる環境は各アカウントのユーザー領域にある環境。

・削除

$ conda remove -n SampleEnv --all

※ 指定した仮想環境を削除。

作成した conda 仮想環境のJupyterLab カーネル登録も Terminal 機能から実施します。

・登録

$ conda run -n SampleEnv ipython kernel install --user \ --name=SampleEnv --display-name=SampleEnv

※ -n でカーネルに登録したい作成済みの conda 仮想環境名称を指定。

※ --name、--display-name で JupyterLab 画面上の表示名称を指定（任意の名称）。

・表示

$ jupyter kernelspec list

※ 表示されるパス直下のkernel.json というファイルに参照している仮想環境の情報が記載。

※ python3 /opt/conda/share/jupyter/kernels/python3 はデフォルトのカーネル。

・削除

$ jupyter kernelspec uninstall sampleenv

※ 指定したカーネルを削除（カーネル名は全て小文字で指定）。

※ JupyterLabのカーネル登録情報のみ削除でありconda 仮想環境は影響無し。