Welcome to the documentation for coxeter! The coxeter Python library provides tools for working with common geometric objects in two and three dimensions. Named for the 20th century geometer best known for his work on polytopes, coxeter is especially focused on polygons and polyhedra, but it also support various standard curved shapes such as spheres and ellipsoids.
The recommended methods for installing coxeter are using pip or conda.
To install the package from PyPI, execute:
pip install coxeter --userTo install the package from conda, first add the conda-forge channel:
conda config --add channels conda-forgeAfter the conda-forge channel has been added, you can install coxeter by executing
conda install coxeterTo install from source, execute:
git clone https://github.com/glotzerlab/coxeter.git
cd coxeter
python setup.py install --user- Python >= 3.6
- NumPy >= 1.15
- SciPy >= 1.0.0
- rowan >= 1.2
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:
pytestTo check test coverage, make sure the coverage module is installed:
pip install coverageand then run the packaged unit tests with the coverage module:
pytest --cov=coxeterDocumentation for coxeter is written in reStructuredText and compiled using Sphinx. To build the documentation, first install Sphinx:
cd doc
pip install -r requirements.txtYou 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:
make html # For html output
make latexpdf # For a LaTeX compiled PDF file
open build/html/index.htmlThis package is hosted on GitHub. Please report any bugs or problems that you find on the issue tracker. All contributions to coxeter are welcomed via pull requests!