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.

Installation

Pythia is available on PyPI as pythia-learn:

$ pip install pythia-learn freud-analysis

You can install pythia from source like this:

$ git clone https://bitbucket.org/glotzer/pythia.git
$ # now install
$ cd pythia && python setup.py install --user

Note

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

Citation

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

Documentation

The documentation is available as standard sphinx documentation:

$ cd doc
$ make html

Automatically-built documentation is available at https://pythia-learn.readthedocs.io .

Usage

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

Examples

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.

Filename, size & hash SHA256 hash help File type Python version Upload date
pythia_learn-0.2.3-py3-none-any.whl (9.5 kB) Copy SHA256 hash SHA256 Wheel py3
pythia-learn-0.2.3.tar.gz (9.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page