rowan 1.3.0.post1

安装

推荐使用pip或conda安装rowan。要从PyPI安装软件包，请执行

$ pip install rowan --user

要从conda安装软件包，首先添加conda-forge通道，然后安装rowan

$ conda config --add channels conda-forge
$ conda install rowan

如果您愿意，也可以通过克隆存储库并运行设置脚本安装rowan

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

使用rowan的最低要求是

• Python >= 3.6

• NumPy >= 1.15

快速入门

此库可以通过实例化适当的NumPy数组并将它们传递到所需的函数中来与四元数一起工作。例如

import rowan
import numpy as np
one = np.array([10, 0, 0, 0])
one_unit = rowan.normalize(one)
assert(np.all(one_unit == np.array([1, 0, 0, 0])))
if not np.all(one_unit == rowan.multiply(one_unit, one_unit)):
    raise RuntimeError("Multiplication failed!")

one_vec = np.array([1, 0, 0])
rotated_vector = rowan.rotate(one_unit, one_vec)

mat = np.eye(3)
quat_rotate = rowan.from_matrix(mat)
alpha, beta, gamma = rowan.to_euler(quat_rotate)
quat_rotate_returned = rowan.from_euler(alpha, beta, gamma)
identity = rowan.to_matrix(quat_rotate_returned)

运行测试

该软件包目前已在Unix-like系统上对Python >= 3.6进行了测试。使用CircleCI在这些Python版本上使用NumPy版本1.15及以上版本进行持续集成测试。

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

python -m unittest discover tests

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

pip install coverage

然后使用覆盖率模块运行软件包的单元测试

coverage run -m unittest discover tests

运行基准测试

软件包的基准测试包含在存储库根目录中的benchmarks文件夹中的Jupyter笔记本中。如果您没有或不想使用笔记本格式，还包括一个等效的Benchmarks.py脚本。这些基准测试将rowan与两个替代软件包进行比较，因此如果您想查看这些比较，则需要安装pyquaternion和numpy_quaternion。

构建文档

您还可以通过克隆存储库从源代码构建此文档。文档是用reStructuredText编写的，并使用Sphinx编译的。要从源代码构建，首先安装Sphinx

pip install sphinx sphinx_rtd_theme

然后您可以使用Sphinx在rowan根目录中运行以下命令来创建实际的文档（PDF或HTML形式）

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