Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
freud 3.3.1 documentation
Logo

Getting Started

  • Introduction
  • Installation
  • Quickstart Guide
  • Migration to freud Version 3
  • Tutorial
    • Periodic Boundary Conditions
    • Compute Classes
    • Finding Neighbors
    • Pair Computations
  • Examples
    • freud.box.Box
    • freud.locality.Filter
    • freud.locality.PeriodicBuffer: Unit Cell RDF
    • freud.locality.Voronoi
    • freud.cluster.Cluster and freud.cluster.ClusterProperties
    • freud.density.CorrelationFunction
    • freud.density.GaussianDensity
    • freud.density.LocalDensity
    • freud.density.RDF: Accumulating g(r) for a Fluid
    • freud.density.RDF: Choosing Bin Widths
    • freud.diffraction.DiffractionPattern
    • freud.diffraction.StaticStructureFactorDirect and freud.diffraction.StaticStructureFactorDebye
    • freud.environment.AngularSeparation
    • freud.environment.BondOrder
    • freud.environment.EnvironmentCluster
    • freud.environment.LocalDescriptors: Steinhardt Order Parameters from Scratch
    • freud.interface.Interface
    • freud.order.Hexatic: Hard Hexagons
    • freud.order.Hexatic: 2D Minkowski Structure Metrics
    • freud.order.Nematic: Nematic Order Parameter and the Nematic Tensor
    • freud.order.Steinhardt
    • freud.pmft.PMFTXY
    • freud.pmft.PMFTXYZ: Shifting Example
    • Implementing Common Neighbor Analysis as a custom method
    • Analyzing simulation data from HOOMD-blue at runtime
    • Analyzing GROMACS data with freud and MDTraj: Computing an RDF for Water
    • Analyzing data from LAMMPS
    • Using Machine Learning for Structural Identification
    • Handling Multiple Particle Types (A-B Bonds)
    • Calculating the Radial Distribution Function (RDF) from Simulation Data
    • Calculating Strain via Voxelization
    • Visualizing analyses with fresnel
    • Visualization with plato
    • Visualizing 3D Voronoi and Voxelization
    • Identifying Local Environments in a Complex Crystal
    • Calculating Smectic Order Parameters
    • Benchmarking Neighbor Finding against scipy
    • Benchmarking RDF against MDAnalysis

Topic Guides

  • Query API
  • Using freud Efficiently
  • Reading Simulation Data for freud

API

  • Box Module
  • Cluster Module
  • Data Module
  • Density Module
  • Diffraction Module
  • Environment Module
  • Interface Module
  • Locality Module
  • MSD Module
  • Order Module
  • Parallel Module
  • PMFT Module

Reference

  • Development Guide
    • Design Principles
    • Contributing to freud
    • Special Topics
      • Memory Management
      • Neighbor Finding
      • Histograms
    • Making freud Releases
  • How to cite freud
  • References
  • License
  • Credits
Back to top

Development of freud is led by the Glotzer Group at the University of Michigan (supported by NSF DMR 1808342) with many external contributions.

Copyright © 2010-2025 The Regents of the University of Michigan
Made with Sphinx and @pradyunsg's Furo
University of Michigan logo