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://github.com/glotzerlab/pythia.git
$ # now install
$ cd pythia && python setup.py install --user

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.

Source Distribution

pythia-learn-0.3.0.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

pythia_learn-0.3.0-py2.py3-none-any.whl (15.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pythia-learn-0.3.0.tar.gz.

File metadata

  • Download URL: pythia-learn-0.3.0.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.8.1

File hashes

Hashes for pythia-learn-0.3.0.tar.gz
Algorithm Hash digest
SHA256 304151a2afc4f36029b273352969f2de52d6e0e38bf36721e8b56e94ac92fafe
MD5 23455648e91499c7b7dd93a12ab95477
BLAKE2b-256 d35f99232ee77ced9333ccfc6c654c5bb51a98ac29c519789c23620d8778ceb7

See more details on using hashes here.

Provenance

File details

Details for the file pythia_learn-0.3.0-py2.py3-none-any.whl.

File metadata

  • Download URL: pythia_learn-0.3.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.8.1

File hashes

Hashes for pythia_learn-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 938ed2b4eca182b616ee0b20e256b6c08cdc82b99adb08a37b7dfe793694b6c8
MD5 cc6010932f90f9f9921dc25471e9b5a6
BLAKE2b-256 3d788b58e487f1352f438d8782bb8ae121889bb8c5c8729832309ed158044ccf

See more details on using hashes here.

Provenance

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