Metadata-Version: 2.1
Name: plato-draw
Version: 1.1.0
Summary: Geometry and visualization tools for collections of particles
Home-page: UNKNOWN
Author: Matthew Spellings
Author-email: mspells@umich.edu
License: BSD
Project-URL: Documentation, http://plato-draw.readthedocs.io/
Project-URL: Source, https://bitbucket.org/glotzer/plato
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: rowan

=================================
Welcome to plato's documentation!
=================================

Plato is designed for efficient visualization of particle data. Think
of it sort of like matplotlib, but being less focused on 2D plotting.

Installation
============

Plato is available on PyPI for installation via pip::

  $ pip install plato-draw --user

You can also install plato from source, like this::

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

.. note::

   If using conda or a virtualenv, the `--user` argument in the
   commands above is unnecessary.

Plato contains a number of backends, each with its own set of
dependencies. Getting the vispy backend working for both the desktop
and jupyter notebook can be tricky. To help users install its
dependencies, we keep some advice `here
<https://bitbucket.org/snippets/glotzer/nMg8Gr/plato-dependency-installation-tips>`_
regarding particular known-good versions of dependencies for pip and
conda.

Documentation
=============

The documentation is available as standard sphinx documentation::

  $ cd doc
  $ make html

Automatically-built documentation is available at
https://plato-draw.readthedocs.io .

Examples
========

Several usage examples are available. Many simple, but less
interesting, scenes can be found in `the test demo scene script
<https://bitbucket.org/glotzer/plato/src/master/test/test_scenes.py>`_. Somewhat
less transparent examples can be found in `the plato-gallery
repository <https://bitbucket.org/glotzer/plato-gallery>`_.



