coxeter 0.4.0

• Setup
  • Installation via pip
  • Installation via conda
  • Installation from source
  • Requirements
  在
• Testing
• Documentation

Setup

建议安装coxeter的方法是使用pip或conda。在

pip install coxeter --user

conda install coxeter

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

Testing

该包目前在类Unix系统上测试Python>；=3.6。 在这些Python版本上使用CircleCI执行连续集成测试。在

要运行打包的单元测试，请从存储库的根目录执行以下行：

pytest

要检查测试覆盖率，请确保已安装覆盖率模块：

pip install coverage

然后使用coverage模块运行打包的单元测试：

pytest --cov=coxeter

Documentation

coxeter的文档用reStructuredText编写，并使用Sphinx编译。 要构建文档，请首先安装Sphinx：

cd doc
pip install -r requirements.txt

然后，您可以通过在coxeter根目录中运行以下命令，使用Sphinx创建PDF或HTML格式的实际文档：

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