【Jupyter Lab】起動時のトップディレクトリを作業ディレクトリに変更する方法

Jupyter Lab

ようこそ、KiRiOのブログへ!

Jupyter Lab を起動したときに以下のような不満を抱えている人はいないでしょうか。

  • 毎回作業ディレクトリまで移動するのが面倒…
  • いつも同じディレクトリから開けばいいのに…

起動後のディレクトリ移動を毎回行うのは明らかに時間の無駄です。
作業ディレクトリが常に(あるいは一定期間)同じであれば、起動時のディレクトリを指定しておきたいですよね。というか、指定しておくべきです。

そこで今回は、Jupyter Lab 起動時のトップディレクトリを指定する方法をご紹介します。


トップディレクトリを指定するためには、以下の手順で行います。

  • Jupyter Labの設定ファイルを作成
  • 作成した設定ファイルに、作業ディレクトリまでのパスを記述

これだけです。簡単ですので、ぜひ参考にしてください。

設定ファイルの作成

初めに、Jupyter Lab の設定ファイルを作成しますので、ターミナルを開いてください
本記事は macOS を想定して書かれていますが、Windows や Linux などでも同様の結果が得られます。

続いて、設定ファイルがすでに存在しているかどうか確認します
ファイル名は jupyter_notebook_config.py で、ホームディレクトリ下の .jupyter/ 下に作成されることになっています。ターミナルで確認しましょう。

  1. $ ls ~/.jupyter/ … (1)

.py ファイルがなければ設定ファイルがまだ作成されていないので、ターミナルで次のコマンドを打って作成します。

  1. $ jupyter notebook --generate-config … (2)

これでホームディレクトリ下に設定ファイルを含んだディレクトリが作成されているはずです。 (1) のコマンドで再度確認してみましょう。

以上で、設定ファイルの作成は完了です。

設定ファイルにトップディレクトリを記述

設定ファイルが作成されましたので、次はファイルを編集して起動時のトップディレクトリを指定します
設定ファイルには多くの情報が記述されています。
ここで余談ですが、ファイルが何行で構成されているかを確認してみましょう。

  1. $ wc ~/.jupyter/jupyter_notebook_config.py … (3)
  2. 1251 6250 47193

左側の数字にあるとおり、設定ファイルは 1,000 行以上にわたってさまざまな情報が記述されていることがわかりました。
そのため、トップディレクトリを指定する記述文がファイルの何行目に書かれているのかを探すのは至難の業です。

そこで、以下のコマンドを入力してください。

  1. $ cat -n ~/.jupyter/jupyter_notebook_config.py | grep c.NotebookApp.notebook_dir … (4)

設定ファイルでは、トップディレクトリに関する文言が “c.NotebookApp.notebook_dir” とされています。
そこで、c.NotebookApp.notebook_dir” を含む文が、ファイルの何行目に書かれているかを確認するのが上記のコマンドです。

コマンドを入力したら、以下のメッセージが返ってくるはずです。

  1. 375 # c.NotebookApp.notebook_dir = ‘’

つまり、設定ファイルの 375 行目にトップディレクトリを指定するメッセージが記述されているのです(行番号には個人差があるかもしれません)。
では、記述箇所がわかったということで、エディタで該当箇所を編集しましょう(ここでは emacs を用いて行います)。

  1. $ emacs ~/.jupyter/jupyter_notebook_config.py & … (5)

375 行目の「’’」の間に指定したいトップディレクトリを絶対パスで記述します
記述が完了したら、ファイルを保存して終了します。

それでは、Jupyter Lab を起動してみてください。
画面左側に表示されるカレントディレクトリが、作業ディレクトリに変更されていれば成功です!

まとめ

今回は、Jupyter Lab 起動時のトップディレクトリを設定する方法をご紹介しました。以下がまとめです。

  1. 設定ファイルが存在しているかを確認
    • $ ls ~/.jupyter/
  2. ファイルがなければコマンドにてファイルを新規作成して確認
    • $ jupyter notebook --generate-config
    • $ ls ~/.jupyter/
  3. c.NotebookApp.notebook_dir” を含む文がファイルの何行目に書かれているかを確認
    • $ cat -n ~/.jupyter/jupyter_notebook_config.py | grep c.NotebookApp.notebook_dir
  4. エディタを開いて該当箇所の「’’」内に作業ディレクトリを絶対パスで記述して保存
    • $ emacs ~/.jupyter/jupyter_notebook_config.py &
  5. Jupyter Lab を起動してカレントディレクトリが作業ディレクトリになっているかを確認

簡単に設定できますので、Jupyter Lab を使用する方にはぜひ知っておいてほしい内容です。
参考になった方は、この記事を拡散して他の方にも教えてあげてください。

また、今回作成した設定ファイルの各項目(オプション)については、下記公式サイトにも記載されていますので、あわせて参照してみてください。

Config file and command line options — Jupyter Notebook 6.4.11 documentation

それでは、ここまで記事を読んでいただき、ありがとうございました。
また別の記事でお会いしましょう。

コメント

タイトルとURLをコピーしました