フロイト

フロイト

概要

freud Python ライブラリは、分子動力学またはモンテカルロ シミュレーションから得られた軌跡を分析するための、シンプルで柔軟かつ強力なツール セットを提供します。高性能の並列化された C++ を使用して、動径分布関数、相関関数、順序パラメータ、クラスターなどの標準ツールに加え、平均力とトルクのポテンシャル (PMFT) やローカル環境マッチングなどの独自の解析手法を計算します。 freudライブラリは多くの入力形式をサポートし、NumPy 配列を出力するため、多くの典型的な材料科学ワークフローの科学 Python エコシステムとの統合が可能になります。

リソース

• 参照ドキュメント: 例、チュートリアル、トピック ガイド、およびパッケージ Python API。
• インストール ガイド: freud のインストールとコンパイルの手順。
• フロイト ディスカッション ボード:フロイトユーザー コミュニティに助けを求めてください。
• GitHub リポジトリ: freudソース コードをダウンロードします。
• 問題トラッカー: 問題を報告したり、機能をリクエストしたりできます。

関連ツール

• HOOMD-blue: freudで分析できる MD / MC シミュレーションを実行します。
• Signac: Signacを使用してワークフローを管理します。

引用

出版用にデータを処理するためにフロイトを使用する場合は、この引用を使用してください。

インストール

freud は、 linux-64 、 osx-64 、 osx-arm64 、およびwin-64アーキテクチャの conda-forge で利用できます。以下を使用してインストールします。

mamba install freud

freud はPyPI でも利用できます。

python3 -m pip install freud-analysis

さらに詳細な情報が必要な場合、またはソースからfreud をインストールしたい場合は、ソースからfreud をコンパイルするためのインストール ガイドを参照してください。

例

freudライブラリは、Python スクリプトを使用して呼び出されます。多くの核となる機能は、freud のドキュメントで実証されています。サンプルは Jupyter ノートブックの形式で提供され、フロイトサンプルリポジトリからダウンロードしたり、Binder で対話的に起動したりすることもできます。以下は、HOOMD-blue で実行されるシミュレーションの動径分布関数を計算し、GSD ファイルに保存するサンプル スクリプトです。

 import freud
import gsd . hoomd

# Create a freud compute object (RDF is the canonical example)
rdf = freud . density . RDF ( bins = 50 , r_max = 5 )

# Load a GSD trajectory (see docs for other formats)
traj = gsd . hoomd . open ( 'trajectory.gsd' , 'rb' )
for frame in traj :
    rdf . compute ( system = frame , reset = False )

# Get bin centers, RDF data from attributes
r = rdf . bin_centers
y = rdf . rdf 

支援と貢献

ライブラリのソース コードについては、GitHub のリポジトリにアクセスしてください。あらゆる問題やバグは問題トラッカーで報告され、質問や議論はディスカッション掲示板に送られることがあります。 freudへのすべての貢献は、プル リクエストを通じて歓迎されます。