Skip to main content

Powerful, efficient trajectory analysis in scientific Python.

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


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.3.0.tar.gz (5.0 MB view details)

Uploaded Source

Built Distributions

freud_analysis-2.3.0-cp38-cp38-manylinux1_x86_64.whl (24.1 MB view details)

Uploaded CPython 3.8

freud_analysis-2.3.0-cp38-cp38-macosx_10_12_x86_64.whl (2.7 MB view details)

Uploaded CPython 3.8 macOS 10.12+ x86-64

freud_analysis-2.3.0-cp37-cp37m-manylinux1_x86_64.whl (24.0 MB view details)

Uploaded CPython 3.7m

freud_analysis-2.3.0-cp37-cp37m-macosx_10_12_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.7m macOS 10.12+ x86-64

freud_analysis-2.3.0-cp36-cp36m-manylinux1_x86_64.whl (24.0 MB view details)

Uploaded CPython 3.6m

freud_analysis-2.3.0-cp36-cp36m-macosx_10_12_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.6m macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: freud-analysis-2.3.0.tar.gz
  • Upload date:
  • Size: 5.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.1 CPython/3.8.5

File hashes

Hashes for freud-analysis-2.3.0.tar.gz
Algorithm Hash digest
SHA256 473b75685543797478deebeb2211da00a6df2dbbca091078c0eb58b2e5584777
MD5 123a25a93ca7dff872e3d9e49aacd64a
BLAKE2b-256 06466787eafce81d7e447cec5649ac11a5ca91d38188593254af092dac3b018f

See more details on using hashes here.

File details

Details for the file freud_analysis-2.3.0-cp38-cp38-manylinux1_x86_64.whl.

File metadata

  • Download URL: freud_analysis-2.3.0-cp38-cp38-manylinux1_x86_64.whl
  • Upload date:
  • Size: 24.1 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.1 CPython/3.8.5

File hashes

Hashes for freud_analysis-2.3.0-cp38-cp38-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 9b3fd555a3a3cf1675318c6e050d69d4c1838d1fcce0c942a83290b4fa0f992e
MD5 64ab7b73461631af260aa5b21e291582
BLAKE2b-256 450ae24b59ed24a2f057b81dbc32348ace0955e30fa2e9ab8aba4e2a73a605a1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: freud_analysis-2.3.0-cp38-cp38-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 2.7 MB
  • Tags: CPython 3.8, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.1

File hashes

Hashes for freud_analysis-2.3.0-cp38-cp38-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 ae234f71a9db0693c979961582877543f7d59171fddded659b518d33800adb1b
MD5 465548b52c5ee384d9f29cf94bf7b83e
BLAKE2b-256 ec1a844d153ddc983ad5d88f78acf7b4f8658f04b4b12b5581bdb9347517b986

See more details on using hashes here.

File details

Details for the file freud_analysis-2.3.0-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: freud_analysis-2.3.0-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 24.0 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.1 CPython/3.8.5

File hashes

Hashes for freud_analysis-2.3.0-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 b6741b3ce0ad5e68f9e20a70f44ae473d15b1c31177eb8de54ad09dbf85663b8
MD5 57a8a82e895c7dbe0d0005bc639b48d9
BLAKE2b-256 3d41418b4552e1161df81d0e149795096add5fa38495d991ffc4b8681de8fd40

See more details on using hashes here.

File details

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

File metadata

  • Download URL: freud_analysis-2.3.0-cp37-cp37m-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: CPython 3.7m, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.1

File hashes

Hashes for freud_analysis-2.3.0-cp37-cp37m-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d95e303fe7d970eea6039b32c38b65954f8a4ec4dc600d3a062d6d96e05dac7a
MD5 7ac0f3600123daf3b745cccf5a2a0a47
BLAKE2b-256 51ab3310490a332af7dbf4592a5a260d917a0aea4aa13bfffe9ef3fb69f2e55a

See more details on using hashes here.

File details

Details for the file freud_analysis-2.3.0-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: freud_analysis-2.3.0-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 24.0 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.1 CPython/3.8.5

File hashes

Hashes for freud_analysis-2.3.0-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 f26ec53ba64c8c0c0937471f1dfee75b1f157d6990803da3e587b4bfe6c2255e
MD5 78f630c1d50bf0174de7b843a6a0a576
BLAKE2b-256 7f06fff7ccc9208d8299155457219638eb07ec2c6a638a7282b29ba912a59a9a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: freud_analysis-2.3.0-cp36-cp36m-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: CPython 3.6m, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.1

File hashes

Hashes for freud_analysis-2.3.0-cp36-cp36m-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d457b6848ac224fdfbe2b9c56d58475f371eb4638b0e1a716eb3339d63b333a7
MD5 048b082ae5ef7a7aa8606faefdffe711
BLAKE2b-256 a0c39704b5cc9cb7955fa6dee73c1768ca06712951a1dbeaa5b18262a84fab90

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