Skip to content
forked from glotzerlab/freud

Powerful, efficient particle trajectory analysis in scientific Python.

License

Notifications You must be signed in to change notification settings

BioCreator/freud

This branch is 2040 commits behind glotzerlab/freud:main.

Folders and files

NameName
Last commit message
Last commit date
Jan 8, 2022
Feb 1, 2022
Jan 2, 2021
Apr 26, 2021
Nov 26, 2021
Jan 25, 2022
Jun 22, 2021
Feb 6, 2022
Feb 2, 2022
Nov 26, 2021
Aug 1, 2020
Nov 8, 2020
Apr 15, 2021
Nov 27, 2021
Jan 25, 2022
Jan 20, 2022
Oct 31, 2021
Nov 11, 2021
May 21, 2020
Jan 25, 2022
Jun 15, 2019
Apr 14, 2020
Mar 15, 2021
Jan 19, 2022
Jan 25, 2022
Apr 9, 2021
Jan 2, 2021
Jan 25, 2022
Jan 25, 2022

Repository files navigation

freud

Citing freud PyPI conda-forge ReadTheDocs Binder GitHub-Stars

Overview

The freud Python library provides a simple, flexible, powerful set of tools for analyzing trajectories obtained from molecular dynamics or Monte Carlo simulations. High performance, parallelized C++ is used to compute standard tools such as radial distribution functions, correlation functions, order parameters, and clusters, as well as original analysis methods including potentials of mean force and torque (PMFTs) and local environment matching. The freud library supports many input formats and outputs NumPy arrays, enabling integration with the scientific Python ecosystem for many typical materials science workflows.

Resources

Related Tools

  • HOOMD-blue: Perform MD / MC simulations that can be analyzed with freud.
  • signac: Manage your workflow with signac.

Citation

When using freud to process data for publication, please use this citation.

Installation

The easiest ways to install freud are using pip:

pip install freud-analysis

or conda:

conda install -c conda-forge freud

freud is also available via containers for Docker or Singularity. If you need more detailed information or wish to install freud from source, please refer to the Installation Guide to compile freud from source.

Examples

The freud library is called using Python scripts. Many core features are demonstrated in the freud documentation. The examples come in the form of Jupyter notebooks, which can also be downloaded from the freud examples repository or launched interactively on Binder. Below is a sample script that computes the radial distribution function for a simulation run with HOOMD-blue and saved into a GSD file.

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

Support and Contribution

Please visit our repository on GitHub for the library source code. Any issues or bugs may be reported at our issue tracker, while questions and discussion can be directed to our user forum. All contributions to freud are welcomed via pull requests!

About

Powerful, efficient particle trajectory analysis in scientific Python.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 52.0%
  • Python 25.6%
  • Cython 21.1%
  • CMake 1.1%
  • Other 0.2%