はじめに¶

PyFIE のインストール方法¶

PyFIE は pip パッケージマネージャにてインストール可能です。 PyFIE の利用には Python および対応するバージョンの WIL または FIE ライブラリのインストールが別途必要となります。以降の説明では Python および pip パッケージマネージャのインストールは完了していることを前提とします。

Windows 64 bit (x64) の場合¶

まず WIL 3.1 を PC にインストールし、 WIL が使用できる動作環境を構築します。詳細は別途資料の「WIL 導入の手引き」を参照してください。

次に、下記のコマンドにより PyFIE をインストールしてください。

pip install -U fast-pyfie

Ubuntu 64 bit (x64) の場合¶

まず FIE for Linux を PC にインストールし、 FIE for Linux が使用できる動作環境を構築します。詳細は FIE for Linux に付属する別途資料「FIE ライブラリの利用手順」を参照してください。

次に、下記の pip3 コマンドにより PyFIE をインストールしてください。

pip3 install -U fast-pyfie

注釈

Ubuntu 20.04 LTS Desktop にプリインストールされる Python では pip3 コマンドにより pip パッケージマネージャを使用できます。その他の方法で pip パッケージマネージャをインストールした場合には当該コマンドを使用できない場合があります。その場合は下記のように pip コマンドでのインストールをお試しください。

pip install -U fast-pyfie

Raspberry Pi 32 bit (arm) の場合¶

まず FIE for Raspberry Pi を PC にインストールし、 FIE for Raspberry Pi が使用できる動作環境を構築します。詳細は FIE for Raspberry Pi に付属する別途資料「Raspberry Pi用FIE利用手順」を参照してください。

次に、下記のコマンドにより PyFIE をインストールしてください。

pip3 install -U fast-pyfie

注釈

Ubuntu の場合と同様に pip3 コマンドを使用できない場合があります。その場合は下記のように pip コマンドでのインストールをお試しください。

pip install -U fast-pyfie

（オプション）whl 形式のパッケージファイルによるインストール¶

PyFIE はパッケージ名でのインストールの他、別途提供される whl 形式のパッケージファイルによりインストールすることも可能です。

各プラットフォームで必要となる WIL または FIE ライブラリをインストールした後、 whl 形式の PyFIE パッケージファイルを用意し、下記のコマンドのようにインストールしてください。

pip install "PyFIE パッケージファイル"
# あるいは、 pip3 install "PyFIE パッケージファイル"

PyFIE パッケージファイルの名前は PyFIE のバージョンやプラットフォームによって変わり、 fast_pyfie-<VERSION>-py3-none-<ARCH>.whl のようになります。 <VERSION> は PyFIE のバージョンを表す文字列であり、例えば "3.9.0.6" になります。 <ARCH> はプラットフォームごとのアーキテクチャ名であり、以下の通りとなります。

Windows 64 bit (x64): win_amd64
Ubuntu 64 bit (x64): manylinux1_x86_64
Raspberry Pi 32 bit (arm / Raspberry Pi 1 系統): linux_armv6l
Raspberry Pi 32 bit (arm / Raspberry Pi 2 以降): linux_armv7l

PyFIE のアップデート方法¶

インストール済みの PyFIE のバージョンが 3.7.2.4 より大きい場合、 PyFIE のインストール方法と同様の手順でアップデートが可能です。

インストール済みの PyFIE のバージョンが 3.7.2.4 以下の場合、下記のコマンドによりインストール済みの PyFIE をアンインストールした後に、改めて PyFIE のインストール方法の手順で再インストールしてください。

pip uninstall pyfie

PyFIE のアンインストール方法¶

下記のコマンドによりアンインストールしてください。

pip uninstall fast-pyfie

PyFIE の使い方¶

PyFIE のモジュール名は pyfie となっておりますので、 Python から下記例のようにインポートすることができます。

import pyfie

PyFIE を初めて使用される方は、まずチュートリアルの基本的な使い方を参照されることをお勧めします。

注釈

Raspberry Pi 32 bit 以外の環境では、FIE ライブラリを使用する際と同様に、 PyFIE を使用する際にはライセンスキーが PC に接続され、認識されている必要があります。

このドキュメントについて¶

用語¶

このドキュメントでは下記の用語が使用されます。

FIE(C 言語)
C 言語版の FIE ライブラリを意味します。 PyFIE ではなく C 言語版であることを明示する場合にこの用語を使用します。

PyFIE 関数リファレンス¶

FIE(C 言語) 関数へのバインディングとして用意されている PyFIE 関数は、対応する FIE(C 言語) 関数と互換仕様となっております。そのため各 PyFIE 関数についてはリファレンスの記載を省略しております。

各 PyFIE 関数の詳細仕様については FIE ライブラリのリファレンスマニュアル を参照ください。

サンプルコード¶

このドキュメントでは FIE(C 言語) を使用した C 言語のサンプルコードと、 PyFIE を使用した Python のサンプルコードを対比させて説明している箇所があります。

下記の形式で示されるものは、 C 言語と Python とで等価なサンプルコードとなります。

C 言語

// C 言語のコード.

Python

# C 言語のコードと等価な Python のコード.

また下記の形式で示されるものは、 C 言語と Python とで一部異なる挙動を含むサンプルコードとなります。

C 言語

// C 言語のコード.

Python

# C 言語のコード一部挙動の異なる Python のコード.

また特に明記されていない場合 Python サンプルコードでは、下記のように PyFIE のインポートが行われているものとします。

Python

import pyfie

注釈

サンプルコードでの関数呼び出しにおいて、注目していない引数を省略して記述している箇所があります。関数呼び出しの引数中に "..." と記述されている箇所は引数の省略が行われているものとします。

注釈

サンプルコードの中には、機能の説明を行うことを目的とするために、処理としては意味のもたないものが含まれています。ご了承ください。