Octave addpathとは？初心者向けにパス追加の基本と使い方を解説

「addpath」は、Octave (や MATLAB) において、関数やデータファイルなどが保存されているディレクトリ（フォルダ）を、Octave が検索するパスに追加するためのコマンドです。

なぜ「addpath」を使うのか？

Octave は、コマンドを実行したり、スクリプト（プログラムファイル）を実行したりする際に、必要な関数やデータファイルを探します。このとき、Octave はあらかじめ決められたいくつかのディレクトリしか検索しません。

もし、あなたが自分で作成した関数ファイル（.m ファイル）や、ダウンロードしてきた外部のツールボックスなどが、これらの標準的なディレクトリ以外の場所に保存されている場合、Octave はそれらを見つけることができず、エラーが発生してしまいます。

「addpath」の基本的な使い方

「addpath」コマンドの基本的な構文は以下の通りです。

addpath('ディレクトリのパス');

• 'ディレクトリのパス' の部分には、追加したいディレクトリのパス（場所を示す文字列）を指定します。

例：

例えば、あなたが作成した関数ファイル my_function.m が、/home/user/my_octave_functions というディレクトリに保存されているとします。この関数を Octave で使うためには、以下のように「addpath」を実行します。

addpath('/home/user/my_octave_functions');

これを実行すると、Octave は /home/user/my_octave_functions ディレクトリも検索対象に含めるようになり、my_function を呼び出すことができるようになります。

複数のパスを追加する場合

複数のディレクトリを一度に追加したい場合は、パスをコロン (:)（Unix/Linux/macOS の場合）またはセミコロン (;)（Windows の場合）で区切って指定します。

addpath('/path/to/dir1:/path/to/dir2:/path/to/dir3'); % Unix/Linux/macOS
addpath('C:\path\to\dir1;C:\path\to\dir2;C:\path\to\dir3'); % Windows

• 相対パスと絶対パス
  ディレクトリのパスは、絶対パス（/home/user/... のように、ルートディレクトリからの完全なパス）または相対パス（現在の作業ディレクトリからの相対的なパス）で指定できます。
• 永続的な追加
  Octave を起動するたびにパスを追加したい場合は、Octave のスタートアップファイル（通常は ~/.octaverc または octave_home/m/startup/octaverc）に addpath コマンドを記述します。
• 一時的な追加
  addpath で追加したパスは、通常、現在の Octave セッションの間だけ有効です。Octave を終了して再度起動すると、追加したパスはリセットされます。

---

ディレクトリのパスの指定ミス

• トラブルシューティング
  
  • パスの確認
    指定したディレクトリのパスが正しいか、タイプミスがないか、大文字・小文字が区別されているかなどを丁寧に確認してください。
  • スペースの扱い
    パスにスペースが含まれる場合は、シングルクォート (') またはダブルクォート (") で囲む必要があります。
  • 特殊文字のエスケープ
    Windows のパスでバックスラッシュ (\) を使う場合は、\\ のようにエスケープするか、スラッシュ (/) を使用することを推奨します。Octave はスラッシュをパス区切り文字として認識します。
  • ディレクトリの存在確認
    exist('ディレクトリのパス', 'dir') コマンドを使って、指定したディレクトリが存在するかどうかを確認できます。
• エラー例
  

  addpath('/home/user/my function'); % スペースが含まれている
  addpath('C:\my documents\octave_files'); % バックスラッシュがエスケープされていない
  addpath('/home/user/nonexistent_dir'); % 存在しないディレクトリ
  

相対パスの誤解

• トラブルシューティング
  
  • 現在の作業ディレクトリの確認
    pwd コマンドを実行して、現在の作業ディレクトリを確認してください。
  • 相対パスの理解
    相対パスは、現在の作業ディレクトリからの相対的な位置関係を示します。意図したディレクトリが現在の作業ディレクトリから見て正しい位置にあるか確認してください。
  • 絶対パスの使用
    相対パスが複雑になる場合は、混乱を避けるために絶対パスを使用することを検討してください。
• エラー例
  現在の作業ディレクトリが /home/user/project1 であるにもかかわらず、addpath('functions') と指定したが、実際には /home/user/project2/functions にファイルがある。

パスの区切り文字の誤り

• トラブルシューティング
  
  • 環境に合わせた区切り文字
    複数のパスを指定する場合は、Unix/Linux/macOS ではコロン (:), Windows ではセミコロン (;) を使用します。Octave は通常、どちらの区切り文字も認識しますが、念のため環境に合わせて使い分けることを推奨します。
• エラー例
  Windows 環境で、複数のパスをコロン (:) で区切って指定した場合。

パーミッションの問題

• トラブルシューティング
  
  • パーミッションの確認
    コマンドライン（ターミナルやコマンドプロンプト）で、指定したディレクトリのパーミッションを確認してください。必要に応じて、読み取り権限を付与してください。
• エラー例
  指定したディレクトリへの読み取り権限がない場合。

スタートアップファイルの問題

• トラブルシューティング
  
  • スタートアップファイルの確認
    スタートアップファイルの内容を慎重に確認し、addpath コマンドの記述に誤りがないかチェックしてください。
  • コメントアウト
    問題のある可能性のある addpath 行を一時的にコメントアウト (# を行頭に追加) して、Octave が正常に起動するかどうかを確認します。
• エラー例
  スタートアップファイル (.octaverc など) に記述した addpath コマンドに誤りがあり、Octave の起動時にエラーが発生する、または意図しないパスが追加される。

競合する関数名

• トラブルシューティング
  
  • 関数名の確認
    追加した関数ファイルの名前と、Octave のワークスペースや他のパスにある関数名が重複していないか確認してください。
  • 関数名の変更
    必要であれば、追加した関数ファイルの名前を変更することを検討してください。
  • パスの優先順位
    Octave は、パスリストの中でより先頭にあるディレクトリを優先的に検索します。パスの追加順序を変更することで、呼び出される関数を制御できる場合があります。path コマンドで現在のパスリストを確認できます。
• エラー例
  追加したパスにある関数ファイルの名前が、Octave の標準関数や他の追加されたパスにある関数ファイルの名前と重複している場合、意図しない関数が呼び出される可能性があります。

• トラブルシューティング
  
  • シンボリックリンクの確認
    シンボリックリンクが正しいディレクトリを指しているか確認してください。リンクが壊れている場合は、修正する必要があります。
• エラー例
  addpath でシンボリックリンクを指定した場合、リンク先のディレクトリが意図しない場所を指している、またはリンクが壊れている。

---

例1：特定のディレクトリにある関数を実行する

まず、Octave の標準パスにはないディレクトリに、自作の関数ファイル my_function.m が保存されているとします。

% my_function.m の内容
function output = my_function(input)
  output = input * 2;
  disp(['my_function が実行されました。入力値: ', num2str(input)]);
end

この my_function.m が、例えば /home/user/my_octave_functions というディレクトリに保存されているとします。この関数を Octave で実行するには、まずこのディレクトリをパスに追加する必要があります。

% Octave のコマンドラインまたはスクリプト内
directory_to_add = '/home/user/my_octave_functions';

% 指定したディレクトリをパスに追加
addpath(directory_to_add);

% 追加したパスにある関数を実行
result = my_function(5);
disp(['結果: ', num2str(result)]);

% (任意) 追加したパスを削除する場合 (現在のセッションのみ)
% rmpath(directory_to_add);

説明

1. directory_to_add = '/home/user/my_octave_functions'; : 追加したいディレクトリのパスを変数に格納します。こうすることで、コードが読みやすくなります。
2. addpath(directory_to_add); : addpath 関数を使って、指定したディレクトリを Octave の検索パスに追加します。これにより、Octave はこのディレクトリ内にある関数やファイルを認識できるようになります。
3. result = my_function(5); : 追加したパスにある my_function を通常通りに呼び出すことができます。
4. disp(['結果: ', num2str(result)]); : 関数の実行結果を表示します。
5. (任意) rmpath(directory_to_add); : rmpath 関数を使うと、追加したパスをパスリストから削除できます。これは、特定の操作が終わった後にパスを整理したい場合に便利です。ただし、削除するとそのパスにある関数は再び認識されなくなります。

例2：複数のディレクトリを一度に追加する

複数のカスタム関数ディレクトリがある場合、一度にそれらすべてをパスに追加できます。

% 複数のディレクトリのパスを定義 (Unix/Linux/macOS の場合)
directories_to_add = '/home/user/functions1:/home/user/functions2:/opt/my_toolbox';

% (Windows の場合)
% directories_to_add = 'C:\Users\user\octave_funcs1;D:\OctaveToolbox';

% addpath を使って複数のディレクトリを一度に追加
addpath(directories_to_add);

% 追加したパスにある関数を呼び出すことができます
% result1 = function_from_functions1(10);
% result2 = function_from_functions2('hello');
% result3 = function_from_my_toolbox(data);

説明

1. directories_to_add = ...; : 追加したい複数のディレクトリのパスを、コロン (:, Unix/Linux/macOS) またはセミコロン (;, Windows) で区切った文字列として定義します。
2. addpath(directories_to_add); : この文字列を addpath に渡すことで、複数のディレクトリが一度にパスに追加されます。

例3：スクリプトの実行時に相対パスでディレクトリを追加する

スクリプトファイル (.m ファイル) と同じディレクトリ、またはそのサブディレクトリにある関数を使用したい場合、相対パスを利用できます。

% my_script.m のあるディレクトリ構成
% my_script.m
% ./utils/my_utility_function.m

% my_utility_function.m の内容
function greet(name)
  disp(['こんにちは、', name, 'さん！']);
end

my_script.m の中で、./utils ディレクトリにある my_utility_function.m を実行するには、以下のようにします。

% my_script.m の内容
% スクリプトファイルのあるディレクトリからの相対パスを指定
utils_path = './utils';
addpath(utils_path);

% 追加したパスにある関数を実行
greet('太郎');

% (任意) 相対パスを絶対パスに変換して表示
full_utils_path = fullfile(pwd, utils_path);
disp(['追加されたパス (絶対): ', full_utils_path]);

説明

1. utils_path = './utils'; : 現在のディレクトリ (.) から見た utils ディレクトリへの相対パスを指定します。
2. addpath(utils_path); : 相対パスを使って addpath を実行します。Octave はこの相対パスを現在の作業ディレクトリに基づいて解釈し、パスに追加します。
3. fullfile(pwd, utils_path); : pwd (present working directory) 関数で現在の作業ディレクトリを取得し、fullfile 関数を使って相対パスを絶対パスに結合します。これは、実際にどのパスが追加されたかを確認するのに役立ちます。

例4：スタートアップファイルにパスを追加して永続化する

Octave を起動するたびに特定のパスを自動的に追加したい場合は、スタートアップファイル (~/.octaverc または octave_home/m/startup/octaverc) に addpath コマンドを記述します。

% ~/.octaverc (例)

% 自分の関数ディレクトリを自動的にパスに追加
addpath('/home/user/my_custom_functions');

% よく使うツールボックスのディレクトリを追加
addpath('/opt/my_favorite_toolbox');

説明

1. Octave のスタートアップファイルを開きます。ファイルの場所はシステムによって異なる場合があります。
2. 追加したい各ディレクトリに対して addpath コマンドを記述します。
3. ファイルを保存します。

これにより、Octave を起動するたびにこれらのパスが自動的に追加され、これらのディレクトリにある関数をすぐに利用できるようになります。

---

OCTAVE_PATH 環境変数の利用

• 注意点
  

  • 環境変数の変更は、新しい Octave セッションを開始するまで反映されません。
  • 複数のプロジェクトで異なるパスが必要な場合には、管理が煩雑になる可能性があります。

• 利点
  

  • Octave の起動時に自動的にパスが設定されるため、スクリプト内で addpath を毎回実行する必要がありません。
  • システム全体またはユーザー全体でパスを管理できます。
• • Unix/Linux/macOS
    
    • ターミナルで一時的に設定する場合:

      export OCTAVE_PATH="/path/to/your/functions:/another/path:$OCTAVE_PATH"
      octave
      

    • 永続的に設定する場合: ~/.bashrc, ~/.zshrc などのシェル設定ファイルに上記の export 行を追加します。
  • Windows
    
    • 「環境変数」の設定画面から OCTAVE_PATH という名前のシステム環境変数またはユーザー環境変数を作成し、追加したいディレクトリのパスをセミコロン (;) で区切って設定します。

ツールボックスのパッケージングとインストール

• 注意点
  

  • ツールボックスの作成には一定の知識と手間が必要です。
  • 個々のスクリプトや少数の関数を扱う場合には、やや大げさな方法かもしれません。

• 利点
  

  • 体系的にツールボックスを管理できます。
  • バージョン管理や依存関係の管理が容易になります。
  • 他のユーザーとの共有や配布が容易です。
  • インストール/アンインストールが簡単に行えます。

• 手順
  

  1. ツールボックスのファイル構成を特定のルールに従って整理します。
  2. パッケージ記述ファイル (DESCRIPTION) を作成します。
  3. 必要に応じて、インストールスクリプト (install.m) やアンインストールスクリプト (uninstall.m) を作成します。
  4. tar.gz 形式などでパッケージファイルをアーカイブします。
  5. Octave 内で pkg install パッケージファイル.tar.gz コマンドを使ってインストールします。

カレントディレクトリの利用

• 注意点
  

  • 複数のディレクトリにまたがるファイルを扱う場合には不便です。
  • カレントディレクトリを頻繁に変更する必要があるため、スクリプトの可読性や管理が難しくなることがあります。

• 利点
  

  • シンプルで手軽です。
  • 一時的な作業や、特定のディレクトリに閉じたプロジェクトに適しています。

• 利用方法
  

  1. cd コマンドを使って、目的のファイルがあるディレクトリに移動します。
  2. 関数名やファイル名を直接指定して実行します。

run コマンドの利用

• 注意点
  

  • スクリプトファイル全体が実行されるため、意図しない処理が含まれている場合に注意が必要です。
  • 大規模な関数群を個別に管理したい場合には不向きです。

• 利用方法
  

  run('/path/to/your/script_with_functions.m');
  % script_with_functions.m 内で定義された関数を呼び出す
  result = my_function_in_script(10);
  

サブディレクトリを自動的にパスに追加するスクリプト

• 注意点
  

  • パスが肥大化し、名前の衝突のリスクが高まる可能性があります。
  • 意図しないディレクトリまでパスに追加される可能性があります。

• 利点
  

  • 深いディレクトリ構造を持つプロジェクトでも、必要な関数を自動的にパスに追加できます。
  • プロジェクトの構成変更に柔軟に対応できます。

• 例
  

  function add_subdirectories_to_path(root_dir)
    subdirs = dir(root_dir);
    for i = 1:length(subdirs)
      if (subdirs(i).isdir && ~strcmp(subdirs(i).name, '.') && ~strcmp(subdirs(i).name, '..'))
        full_subdir_path = fullfile(root_dir, subdirs(i).name);
        addpath(full_subdir_path);
        add_subdirectories_to_path(full_subdir_path); % 再帰的にサブディレクトリを探索する場合
      end
    end
  end
  
  % 使用例: 特定のルートディレクトリ以下のすべてのサブディレクトリをパスに追加
  root_directory = '/path/to/your/project';
  add_subdirectories_to_path(root_directory);