用于创建和操作形状的工具。
coxeter的Python项目详细描述
调酒师
欢迎使用coxeter的文档! coxeterPython库提供了处理二维和三维常见几何对象的工具。 以20th century geometer最著名的多面体研究命名,coxeter特别关注多边形和多面体,但它也支持各种标准的曲线形状,如球体和椭球体。在
Setup
建议安装coxeter的方法是使用pip或conda。在
Installation via conda
要从conda安装包,首先添加conda forge通道:
^{pr2}$添加conda forge通道后,可以通过执行
conda install coxeter
Installation from source
要从源安装,请执行:
git clone https://github.com/glotzerlab/coxeter.git
cd coxeter
python setup.py install --user
Requirements
- Python>;=3.6
- NumPy>;=1.15
- SciPy>;=1.0.0
- rowan>;=1.2
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
支持与贡献
此包托管在GitHub。 请报告您在issue tracker上发现的任何错误或问题。 欢迎所有对coxeter的贡献通过拉请求!在
- 项目
标签: