Skip to main content

A Python package to compute bond orientational order parameters

Project description

# pyboo
A Python package to compute bond orientational order parameters as defined by Steinhardt Physical Review B (1983) doi:10.1103/PhysRevB.28.784.

Steinhardt's bond orientational order parameter is a popular method (>20k citations of the original paper) to identify local symmetries in an assembly of particles in 3D. It can be used in particle-based simulations (typically molecular dynamics, brownian dynamics, monte-carlo, etc.) or in particle-tracking experiments (colloids, granular materials) where the coordinates of all particles are known.

## Licence, citations, contact

This code is under GPL 3.0 licence. See LICENCE file.

Please cite Pyboo and it's author(s) in any scientific publication using this software.

```
@misc{
pyboo,
title={Pyboo: A Python package to compute bond orientational order parameters},
author={Mathieu Leocmach},
year={2017},
doi={10.5281/zenodo.1066568},
url={https://github.com/MathieuLeocmach/pyboo}
}
```

Contact
Mathieu LEOCMACH, Institut Lumière Matière, UMR-CNRS 5306, Lyon, France
mathieu.leocmach AT univ-lyon1.fr


## Installation

Dependencies are numpy, scipy and numba. Tested with python 2.7 and python 3.5.

You can install with pip:
pip install pyboo


## Documentation

Documentation is avaiable on Readthedocs: [http://pyboo.readthedocs.io]

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

pyboo-1.0.0.tar.gz (1.1 MB view hashes)

Uploaded source

Supported by

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