Powerful, efficient trajectory analysis in scientific Python.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for b-butler from gravatar.com b-butler Avatar for bdice from gravatar.com bdice Avatar for joaander from gravatar.com joaander Avatar for kelwang from gravatar.com kelwang Avatar for tcmoore3 from gravatar.com tcmoore3 Avatar for tomwalt from gravatar.com tomwalt Avatar for vramasub from gravatar.com vramasub

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License
  • Author: Vyas Ramasubramani et al.
  • Maintainer: freud Developers
  • Tags simulation, analysis, molecular, dynamics, soft, matter, particle, system, computational, physics
  • Requires: Python >=3.6
Classifiers

Project description

Citing freud PyPI conda-forge ReadTheDocs Binder Codecov 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

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!

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for b-butler from gravatar.com b-butler Avatar for bdice from gravatar.com bdice Avatar for joaander from gravatar.com joaander Avatar for kelwang from gravatar.com kelwang Avatar for tcmoore3 from gravatar.com tcmoore3 Avatar for tomwalt from gravatar.com tomwalt Avatar for vramasub from gravatar.com vramasub

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License
  • Author: Vyas Ramasubramani et al.
  • Maintainer: freud Developers
  • Tags simulation, analysis, molecular, dynamics, soft, matter, particle, system, computational, physics
  • Requires: Python >=3.6
Classifiers

Release history Release notifications | RSS feed

3.1.0

3.0.0

2.13.2

2.13.1

2.13.0

2.12.1

2.12.0

2.11.0

2.10.0

2.9.0

2.8.0

2.7.0

2.6.2

2.6.1

2.6.0

2.5.1

2.5.0

2.4.1

This version

2.4.0

2.3.0

2.2.0

2.1.0

2.0.1

2.0.0

1.2.2

1.2.1

1.2.0

1.1.0

1.0.0

0.11.4

0.11.3

0.10.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

freud-analysis-2.4.0.tar.gz (3.3 MB view details)

Uploaded Source

Built Distributions

freud_analysis-2.4.0-cp39-cp39-manylinux2010_x86_64.whl (3.9 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.12+ x86-64

freud_analysis-2.4.0-cp39-cp39-macosx_10_12_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.9 macOS 10.12+ x86-64

freud_analysis-2.4.0-cp38-cp38-manylinux2010_x86_64.whl (3.9 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.12+ x86-64

freud_analysis-2.4.0-cp38-cp38-macosx_10_12_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.8 macOS 10.12+ x86-64

freud_analysis-2.4.0-cp37-cp37m-manylinux2010_x86_64.whl (3.9 MB view details)

Uploaded CPython 3.7m manylinux: glibc 2.12+ x86-64

freud_analysis-2.4.0-cp37-cp37m-macosx_10_12_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.7m macOS 10.12+ x86-64

freud_analysis-2.4.0-cp36-cp36m-manylinux2010_x86_64.whl (3.9 MB view details)

Uploaded CPython 3.6m manylinux: glibc 2.12+ x86-64

freud_analysis-2.4.0-cp36-cp36m-macosx_10_12_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.6m macOS 10.12+ x86-64

File details

Details for the file freud-analysis-2.4.0.tar.gz.

File metadata

  • Download URL: freud-analysis-2.4.0.tar.gz
  • Upload date:
  • Size: 3.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for freud-analysis-2.4.0.tar.gz
Algorithm Hash digest
SHA256 e69b3ed27b61900ea8a27779c0cfb2de07fa610c9b34121d0e38b4d1b0212c68
MD5 9b7a21386bba4d9e274e313f6729129f
BLAKE2b-256 d704c1fae86f1dbed7109bd4f19259eb21c4e637204a6a384634473417c78044

See more details on using hashes here.

File details

Details for the file freud_analysis-2.4.0-cp39-cp39-manylinux2010_x86_64.whl.

File metadata

  • Download URL: freud_analysis-2.4.0-cp39-cp39-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 3.9 MB
  • Tags: CPython 3.9, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for freud_analysis-2.4.0-cp39-cp39-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 0ac489b6a5101f9431c754bc895b4930fbac2879c4531eb6f3e9d4e1e71ac901
MD5 66c5a1fe6aa6fcc2c0e08058b055c5c1
BLAKE2b-256 605b4df7c439a9c717f879859c531b8023f8ba26872ba288043e84af455782d5

See more details on using hashes here.

File details

Details for the file freud_analysis-2.4.0-cp39-cp39-macosx_10_12_x86_64.whl.

File metadata

  • Download URL: freud_analysis-2.4.0-cp39-cp39-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.9, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for freud_analysis-2.4.0-cp39-cp39-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 9887bcf3fbdce41ca762181002c9ab61025f52a60776f50b83104a21454f86fb
MD5 a7194bac6a87f1420ed466699570a032
BLAKE2b-256 359bb154f0f0df66146d37394692adf2e3504f2f8cd8a2ba7b6418da7a468013

See more details on using hashes here.

File details

Details for the file freud_analysis-2.4.0-cp38-cp38-manylinux2010_x86_64.whl.

File metadata

  • Download URL: freud_analysis-2.4.0-cp38-cp38-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 3.9 MB
  • Tags: CPython 3.8, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for freud_analysis-2.4.0-cp38-cp38-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 905f634bd47d27c676f1a75cab7399f3944e19f3230c86547d1ef4170db297cf
MD5 6ecc4a0be911bc5b81b32aa0eae849cc
BLAKE2b-256 6ff2c98a1856980419b07967cb104eaa9212b6c3d2c889e745f86f44f4463e3e

See more details on using hashes here.

File details

Details for the file freud_analysis-2.4.0-cp38-cp38-macosx_10_12_x86_64.whl.

File metadata

  • Download URL: freud_analysis-2.4.0-cp38-cp38-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.8, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for freud_analysis-2.4.0-cp38-cp38-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 5e84fedd17ce88b788554a14913a9b408efd02e82aea710d245e886da7bfd1e1
MD5 8c44c80a8ac96fd9c98a5f178fe20adc
BLAKE2b-256 59a434af07df28af40d979ca77bee1c328761b01b47772fa4f543423b6d0f997

See more details on using hashes here.

File details

Details for the file freud_analysis-2.4.0-cp37-cp37m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: freud_analysis-2.4.0-cp37-cp37m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 3.9 MB
  • Tags: CPython 3.7m, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for freud_analysis-2.4.0-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 ed8d2fe9f781b52e523151093e23a7bdbe86fd281324e00e5a2fdde4c68bc088
MD5 cbc0f6eafb2a21af2f5b69f91e5d8ac3
BLAKE2b-256 2c7c11de71ef4b627c52b50c7a1399d8f0d3c09086f162624536d026e22b9f1b

See more details on using hashes here.

File details

Details for the file freud_analysis-2.4.0-cp37-cp37m-macosx_10_12_x86_64.whl.

File metadata

  • Download URL: freud_analysis-2.4.0-cp37-cp37m-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.7m, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for freud_analysis-2.4.0-cp37-cp37m-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 49124102a0770d4b075319022707288a59eeda3c1bf2bb2f8a206558f1bf6760
MD5 c099bfb73c02a4058d02795c94e6d6ae
BLAKE2b-256 7552695b498da8be0fa17b5b18d4ee78871e49b9b6b664e6d551db7c5c34d925

See more details on using hashes here.

File details

Details for the file freud_analysis-2.4.0-cp36-cp36m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: freud_analysis-2.4.0-cp36-cp36m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 3.9 MB
  • Tags: CPython 3.6m, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for freud_analysis-2.4.0-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 9bea9aa963f62fbaf0f63aadad00f34469e67399ceff1fb237bcc378603ccdf4
MD5 08651c94ac7078af96d32c86435e945c
BLAKE2b-256 1b89c12ff3a7e431673b86ce6743c43863962f3bbb55daa4c10a092a5bc71d22

See more details on using hashes here.

File details

Details for the file freud_analysis-2.4.0-cp36-cp36m-macosx_10_12_x86_64.whl.

File metadata

  • Download URL: freud_analysis-2.4.0-cp36-cp36m-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.6m, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for freud_analysis-2.4.0-cp36-cp36m-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 c1b129689ad10d543f018c9f89ac9421974bfeff6beaa65768fffce79f965ab9
MD5 e6b8d9bc14c2afa7175e0fd371d934e4
BLAKE2b-256 31a9a44ad8c327e90a26701e069f38b834f586d2edb8d9dd6457e3dcf1886e9f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page