coxeter 0.3.0

Setup

The recommended methods for installing coxeter are using pip or conda.

pip install coxeter --user

conda config --add channels conda-forge

conda install coxeter

git clone https://github.com/glotzerlab/coxeter.git
cd coxeter
python setup.py install --user

Testing

The package is currently tested for Python >= 3.6 on Unix-like systems. Continuous integrated testing is performed using CircleCI on these Python versions.

To run the packaged unit tests, execute the following line from the root of the repository:

pytest

To check test coverage, make sure the coverage module is installed:

pip install coverage

and then run the packaged unit tests with the coverage module:

pytest --cov=coxeter

Documentation

Documentation for coxeter is written in reStructuredText and compiled using Sphinx. To build the documentation, first install Sphinx:

pip install sphinx sphinx_rtd_theme

You can then use Sphinx to create the actual documentation in either PDF or HTML form by running the following commands in the coxeter root directory:

cd doc
make html # For html output
make latexpdf # For a LaTeX compiled PDF file
open build/html/index.html