Skip to main content

Welcome to pythia’s documentation!

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:

Metadata

Release files for pythia-learn 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pythia-learn 0.3.0
File Size Uploaded Provenance Actions
pythia-learn-0.3.0.tar.gz 13.8 kB Without provenance Details for pythia-learn-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pythia-learn 0.3.0
File Interpreter ABI Platform Actions
pythia_learn-0.3.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for pythia_learn-0.3.0-py2.py3-none-any.whl

Total release size: 29.6 kB

Release files / pythia-learn-0.3.0.tar.gz

Download URL pythia-learn-0.3.0.tar.gz
Size 13.8 kB
Tags Source
SHA-256 checksum
How to use checksums
304151a2afc4f36029b273352969f2de52d6e0e38bf36721e8b56e94ac92fafe
BLAKE2b-256 checksum
How to use checksums
d35f99232ee77ced9333ccfc6c654c5bb51a98ac29c519789c23620d8778ceb7
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / pythia_learn-0.3.0-py2.py3-none-any.whl

Download URL pythia_learn-0.3.0-py2.py3-none-any.whl
Size 15.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
938ed2b4eca182b616ee0b20e256b6c08cdc82b99adb08a37b7dfe793694b6c8
BLAKE2b-256 checksum
How to use checksums
3d788b58e487f1352f438d8782bb8ae121889bb8c5c8729832309ed158044ccf
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for pythia-learn 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page