paper

freud: A Software Suite for High Throughput Analysis of Particle Simulation Data

arXiv:1906.06317 · doi:10.1016/j.cpc.2020.107275

Abstract

The freud Python package is a powerful library for analyzing simulation data. Written with modern simulation and data analysis workflows in mind, freud provides a Python interface to fast, parallelized C++ routines that run efficiently on laptops, workstations, and supercomputing clusters. The package provides the core tools for finding particle neighbors in periodic systems, and offers a uniform API to a wide variety of methods implemented using these tools. As such, freud users can access standard methods such as the radial distribution function as well as newer, more specialized methods such as the potential of mean force and torque and local crystal environment analysis with equal ease. While many comparable tools place a heavy emphasis on reading and operating on trajectory file formats, freud instead accepts numerical arrays of data directly as inputs. By remaining agnostic to its data source, freud is suitable for analyzing any coarse-grained particle simulation, regardless of the original data representation or simulation method. When used for on-the-fly analysis in conjunction with scriptable simulation software such as HOOMD-blue, freud enables smart simulations that adapt to the current state of the system, allowing users to study phenomena such as nucleation and growth.

arXiv commentThis paper is accepted for publication in Computer Physics Communications. For the source code on Github, see https://github.com/glotzerlab/freud . For the documentation on ReadTheDocs, see https://freud.readthedocs.io/en/stable

References in corpus (14)

Cited by in corpus (59)