導入
Pixyz SDK の Python API 環境を構築する方法について説明します。
この記事は英文のドキュメントの日本語訳です。記事はベストエフォートで翻訳を進めているため、ローカライズされたコンテンツは最新の情報ではない場合があります。最新の情報は英語版のドキュメントを参照してください。
参照元 Pixyz SDK - Python SDK Setup
環境
Pixyz SDK 2024.2
解決策
事前準備
- 必須システム要件を満たす - System requirements
- Python 3.10 以降をインストールする
- Pixyz License Portal において Pixyz SDK ライセンスを所持する
設定方法
PyCharm
- Pixyz SDKをダウンロードします
- PyCharmでプロジェクトを開きます
- ローカルマシン上のPixyzバイナリフォルダまたはローカルの開発環境の場所を確認します
- Pixyzバイナリフォルダをインタープリターのパスに追加します - インタープリターのパスを管理する - PyCharm (外部リンク)
- ライセンスサーバーを設定し、Pixyz SDKのフローティングライセンスが利用できるようにします
- 初めてのスクリプトを実行してください。
Visual Studio Code
- Pixyz SDKをダウンロードします
- Visual Studio Codeでプロジェクトを開きます
- VS Codeを起動します。
- 以下のいずれかの方法でプロジェクトを開きます:
- メニューバーから「File」→「Open Folder」を選択
- キーボードショートカット「Ctrl+K Ctrl+O」(Windows/Linux) または「Cmd+O」(Mac)を使用 - ファイルエクスプローラーでプロジェクトのフォルダを選択します。
- Python環境を構築します - Visual Studio Code の Python 環境 (Windows) (外部リンク)
作成方法の詳細については上記Microsoft社様のドキュメントをご参照ください。 - "PYTHONPATH"にPixyzバイナリフォルダへのパスに指定します
例として、以下の様な .env ファイルをプロジェクトディレクトリに追加し設定することができます。
PYTHONPATH=C:/<path-to-your-project-directory>/PiXYZAPI-2024.3.0.2/PiXYZAPI-2024.3.0.2-win64/bin
- ライセンスサーバーを設定し、Pixyz SDKのフローティングライセンスが利用できるようにします
- 初めてのスクリプトを実行してください。
初めてのスクリプト
import pxz
from pxz import core
# init Pixyz
pxz.initialize()
# print Pixyz version
print(core.getVersion())
# set log level to INFO so you can see the logs in the console
core.configureInterfaceLogger(True, True, True)
core.addConsoleVerbose(core.Verbose.INFO)
# if no license is found, try to configure a license server
if not core.checkLicense():
core.configureLicenseServer("company-server-hostname", 27000, True)
# add all tokens
for token in pxz.core.listTokens():
try:
core.needToken(token)
except:
pass
# use io.importScene to import a file and enjoy :)
初めてのスクリプトを実行すると以下の様な出力となります。
このスクリプトはライセンスが取得できるかどうかの確認のためのスクリプトとなります。
エラーなく実行が完了した場合、正常にPixyz SDK の Python SDK の実行環境の構築ができています。
Initializing with default product name: PixyzSDK
[2024/11/01 11:09:44] PixyzSDK v2024.3.0.2
[2024/11/01 11:09:44] Loading plugin C:/GoogleDriveSyncDir/Projects/PixyzSDK/PiXYZAPI-2024.3.0.2/PiXYZAPI-2024.3.0.2-win64/bin/plugins/HoopsImportPlugin/HoopsImportPlugin.dll
[2024/11/01 11:09:44] Loading plugin C:/GoogleDriveSyncDir/Projects/PixyzSDK/PiXYZAPI-2024.3.0.2/PiXYZAPI-2024.3.0.2-win64/bin/plugins/OdaImportPlugin/OdaImportPlugin.dll
2024.3.0.2
[2024/11/01 11:09:44]
[2024/11/01 11:09:44] executing command core.needToken
[2024/11/01 11:09:44] tokenName: "PixyzSDK"
[2024/11/01 11:09:44] Command execution time : 0.000 s
[2024/11/01 11:09:44]
[2024/11/01 11:09:44] executing command core.needToken
[2024/11/01 11:09:44] tokenName: "AllFormats"
... <Token nameがリストされます>
[2024/11/01 11:09:44] Command execution time : 0.000 s