Skip to main content

Post-processing tools for particle simulations

Project description


pypi version license Binder pipeline coverage report

A Python package to compute static and dynamic correlation functions from simulations of interacting particles, such as molecular dynamics or Monte Carlo simulations. Based on atooms.

Quick start

Postprocessing works on trajectories. Any trajectory format recognized by atooms can be processed, for instance most "xyz" files should work fine. If you use a custom trajectory format, it is easy to add it.

As an example, we compute the structure factor S(k) from the file in the data/ folder.

From the command line --norigins 0.2 msd data/

We just used 20% of the available time frames to compute the averages using the --norigins flag. Without it, atooms-pp applies an heuristics to determine the number of time frames required to achieve a reasonable data quality. The results of the calculation are stored in the file data/

From Python

The same calculation can be done from Python:

from atooms.trajectory import Trajectory
import atooms.postprocessing as pp

with Trajectory('data/') as t:
     p = pp.StructureFactor(t)


Available correlation and distribution functions

  • Real space
    • radial distribution function
    • mean square displacement
    • velocity auto-correlation function
    • self overlap functions
    • collective overlap functions
    • dynamic susceptibility of the self overlap function
    • non-Gaussian parameter
    • bond-angle distribution
  • Fourier space
    • structure factor
    • spectral density
    • self intermediate scattering functions
    • collective intermediate scattering functions
    • four-point dynamic susceptibility


Check out the tutorial for more examples and the public API for full details.

Org-mode and jupyter notebooks are available under docs/. You can run the tutorial interactively on Binder.


  • numpy
  • atooms
  • [optional] argh (only needed when using
  • [optional] tqdm (enable progress bars)
  • [optional] argcomplete (enable tab-completion for
  • [optional] fortran compiler for more efficient execution


Install with pip

pip install atooms-pp

Or clone the project repository

git clone
cd postprocessing
make install


Contributions to the project are welcome. If you wish to contribute, check out these guidelines.


Daniele Coslovich:

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

atooms-pp-3.4.0.tar.gz (60.2 kB view hashes)

Uploaded Source

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