開発環境PyCharmのセットアップ

JetBrainsのPython IDE PyCharm を使ったAGX Pythonの開発環境のセットアップ手順について説明する。
参考文献
- PyCharm — AGX Dynamics documentation
確認環境
- Windows 10 Pro
- agx-2.39.0.1-x64-VS2022-double.exe
- pycharm-community-2024.3.exe

グローバル設定

PyCharmを起動し、次の項目を設定する。

agxPyファイルをPythonファイルとして関連付ける

agxPyファイルをPythonファイルとして扱われるように関連付ける。関連付けをすると、次のことができる。

PyCharmからagxPyファイルの実行
AGX APIの補間や定義への移動、シンタックスハイライト

手順

PyCharmのメニューバーから File ‣ Settings を選択するか、ショートカット Ctrl + Alt + S を入力し、「Settings」を開く。

Editor > File Types を選択する。

右側ペインの Recognized File Types から Python を選択する。

File name patterns: の + を選択する。

Add Wildcard の Enter new wildcard: に *.agxPy と入力し、OK を選択する。

File name patterns: に *.agxPy が追加されていることを確認する。

「Settings」の OK を選択し、ウィンドウを閉じる。

PyCharmがコーディング支援を提供するファイルの最大サイズを大きくする

AGX PythonのAPIの補間を正しく効かせるために idea.max.intellisense.filesize を大きくする。

PyCharmにはコーディング支援を提供するファイルの最大サイズ(キロバイト単位)が定められている( 詳細な構成 | PyCharm ドキュメント)。 AGX Pythonパッケージのファイルサイズが大きいためか、コーディング支援を提供するファイルの最大サイズを超過しているようで、一部のAPIの補間が効かない。次の手順で最大サイズを大きくする。

手順

PyCharmのメニューバーから Help ‣ Edit Custom Properties を選択する。

idea.properties ファイルに次の行を追加する。

idea.max.intellisense.filesize=10000

設定後、PyCharmを再起動する。

プロジェクト設定

特定のAGXを使ったPythonプロジェクトに対する設定をする。ここではAGXのPythonフォルダ <AGX_DIR>\data\python を例として設定する。

PyCharmでAGXのPythonプロジェクトを開く

AGXの環境変数が設定されたコマンドプロンプトを開く <AGX_DIR>\agx_cmd.bat 。

プロンプトに pycharm または PyCharmの実行ファイルパスを入力し、PyCharmを起動する。

メニューバーから File ‣ Open を選択し、<AGX_DIR>>\data\python を開く。

Pythonインタプリタの設定

PyCharmのメニューバーから File ‣ Settings を選択し、「Settings」の Project ‣ Python Interpreter を選択する。

Add Interpreter、 Add Local Interpreter を選択する。次のいずれかの方法でプロジェクトに使うPythonインタプリタを指定する。

既存のPython環境を使う場合

Environment:: Select existing
Type:: Python
Python path:: python.exeへのパス

プロジェクト専用のPython環境を使う場合

Environment:: Generate new
Type:: Virtualenv
Base python:: python.exe へのパス
Location:: .venv を保存する場所(変更の必要なし)
Inherit packages from base interpreter:: OFF (必要に応じて ON)
Make available to all projects:: OFF

登録後、Apply で設定を反映する。

AGX PythonのAPIを補間できるようにする

PyCharmのメニューバーから File ‣ Settings を選択し、「Settings」の Project ‣ Python Structure を選択する。

右側の + Add Content Root を選択する。

Select Content Root Directory に <AGX_DIR>\bin\x64\agxpy を指定し、 OK を選択する。

Apply で設定を反映する。

動作確認

注釈

AGX Pythonプロジェクトを開くときは、必ずPyCharmにAGXの環境変数が設定されている状態にする。

AGXの環境変数が設定されたコマンドプロンプトを開く <AGX_DIR>\agx_cmd.bat 。

プロンプトに pycharm または PyCharmの実行ファイルパスを入力し、PyCharmを起動する。

メニューバーから File ‣ Open を選択し、<AGX_DIR>>\data\python を開く。

プロジェクトツールウィンドウから tutorials/tutorial2_python3_agxViewer.agxPy を選択する。

次のいれずれかの方法でプログラムを実行する。

ツールバーのボタンから実行

ツールバーから実行対象のファイル( Current File か実際のファイル名)を確認し、▶️ (Run) を選択する。

コンテキストメニューから実行

プロジェクトツールウィンドウのファイルのコンテキストメニューを開き、Run を選択する。

ショートカットキーから実行

Ctrl + Alt + F5 を入力して実行する。