Freud

Freud

Aperçu

La bibliothèque Freud Python fournit un ensemble d'outils simples, flexibles et puissants pour analyser les trajectoires obtenues à partir de dynamiques moléculaires ou de simulations de Monte Carlo. Le C++ parallélisé hautes performances est utilisé pour calculer des outils standards tels que des fonctions de distribution radiale, des fonctions de corrélation, des paramètres d'ordre et des clusters, ainsi que des méthodes d'analyse originales incluant les potentiels de force et de couple moyens (PMFT) et la correspondance avec l'environnement local. La bibliothèque Freud prend en charge de nombreux formats d'entrée et sorties de tableaux NumPy, permettant l'intégration à l'écosystème scientifique Python pour de nombreux flux de travail typiques de la science des matériaux.

Ressources

• Documentation de référence : exemples, didacticiels, guides thématiques et packages d'API Python.
• Guide d'installation : Instructions pour installer et compiler Freud .
• Forum de discussion Freud : demandez de l'aide à la communauté des utilisateurs de Freud .
• Dépôt GitHub : téléchargez le code source de Freud .
• Suivi des problèmes : signalez des problèmes ou demandez des fonctionnalités.

Outils associés

• HOOMD-blue : effectuez des simulations MD/MC pouvant être analysées avec Freud .
• signac : gérez votre flux de travail avec signac .

Citation

Lorsque vous utilisez Freud pour traiter des données à publier, veuillez utiliser cette citation.

Installation

Freud est disponible sur conda-forge pour les architectures linux-64 , osx-64 , osx-arm64 et win-64 . Installer avec :

mamba install freud

Freud est également disponible sur PyPI :

python3 -m pip install freud-analysis

Si vous avez besoin d'informations plus détaillées ou si vous souhaitez installer Freud à partir des sources, veuillez vous référer au Guide d'installation pour compiler Freud à partir des sources.

Exemples

La bibliothèque Freud est appelée à l'aide de scripts Python. De nombreuses fonctionnalités principales sont démontrées dans la documentation de Freud. Les exemples se présentent sous la forme de cahiers Jupyter, qui peuvent également être téléchargés à partir du référentiel d'exemples Freud ou lancés de manière interactive sur Binder. Vous trouverez ci-dessous un exemple de script qui calcule la fonction de distribution radiale pour une simulation exécutée avec HOOMD-blue et enregistrée dans un fichier 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 

Soutien et contribution

Veuillez visiter notre référentiel sur GitHub pour le code source de la bibliothèque. Tout problème ou bug peut être signalé via notre système de suivi des problèmes, tandis que les questions et discussions peuvent être adressées à notre forum de discussion. Toutes les contributions à Freud sont les bienvenues via des pull request !