Skip to main content

Machine learning fingerprints for particle environments

Project description

Pythia is a library to generate numerical descriptions of particle systems. Most methods rely heavily on freud for efficient neighbor search and other accelerated calculations.


Pythia is available on PyPI as pythia-learn:

$ pip install pythia-learn freud-analysis

You can install pythia from source like this:

$ git clone
$ # now install
$ cd pythia && python install --user


If using conda or a virtualenv, the –user argument in the pip command above is unnecessary.


In addition to the citations referenced in the docstring of each function, we encourage users to cite the pythia project itself.


The documentation is available as standard sphinx documentation:

$ cd doc
$ make html

Automatically-built documentation is available at .


In general, data types follow the hoomd-blue schema:

  • Positions are an Nx3 array of particle coordinates, with (0, 0, 0) being the center of the box
  • Boxes are specified as an object with Lx, Ly, Lz, xy, xz, and yz elements
  • Orientations are specified as orientation quaternions: an Nx4 array of (r, i, j, k) elements


Example notebooks are available in the examples directory:

Project details

Download files

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

Files for pythia-learn, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size pythia_learn-0.3.0-py2.py3-none-any.whl (15.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pythia-learn-0.3.0.tar.gz (13.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page