其它

援引Mayavi

Mayavi的核心开发人员都是学术界的。被引用次数将证明他们在Mayavi上投入的时间和精力是有意义的。如果您在学术文章中使用Mayavi,请援引如下:(bibtex:citation.bib)

Ramachandran, P. and Varoquaux, G., Mayavi: 3D Visualization of Scientific Data IEEE Computing in Science & Engineering, 13 (2), pp. 40-51 (2011)

教程视频

下面很多教程视频将帮助您学习Mayavi:

获取帮助

Bug报告请提交至issue tracker https://github.com/enthought/mayavi/issues。并确保提供足够多的信息以便我们重现问题。如果Mayavi的网站,wiki,stack overflow和google都不能为您提供帮助,请到`issue tracker`上自由提问。

如果您有问题,您可以用Mayavi-users mailing <https://sourceforge.net/p/mayavi/mailman/mayavi-users/>`提问。一部分人使用它,并不是很活跃。至于另一个列表——使用Enthought Tool Suite的人会访问ETS Users mailing list `<https://groups.google.com/forum/#!forum/ets-users>,它更加通用。

Mayavi测试

您可以在命令行中使用`mayavi2 -t`运行Mayavi测试案例。在一些特殊的操作系统上运行测试案例将有助于检测Mayavi是否工作正常。诚然系统之间存在差异:除了操作系统本身的不同,还存在库的版本问题。但Mayavi的开发者竭力兼容不同的配置,您可以通过运行测试案例以及提交错误的方式帮助他们完善。

您可以按照下面的方式,从Mayavi根目录中,使用 nose 运行测试扩展库的单元测试:

$ nosetests
----------------------------------------------------------------------
Ran 317 tests in 29.934s

OK (SKIP=5)

如果测试mayavi的tests部分,在mayavi源目录中使用以下命令:

$ nosetests mayavi/tests
----------------------------------------------------------------------
Ran 231 tests in 14.066s

OK (SKIP=4)

如果仅测试tvtk包,您可以在mayavi源目录中使用以下命令:

$ nosetests tvtk/tests
----------------------------------------------------------------------
Ran 87 tests in 9.080s

OK (SKIP=1)

如果您捕获了一个不可用的错误,您可以选择忽略它。基于一些原因,nose并不能很好地运行它们,它们中有一些在tvtk/tests 和 mayavi/tests文件夹中。您可以手动逐一运行test_*.py 文件,也可以切换当前目录去它们所在的目录运行`nosetests`命令。

除了几个单元测试之外,Mayaiv也有集成测试。它们放在`integrationtests/mayavi`文件夹中。您可以对它们进行测试:

$ ./run.py

这些测试是侵入式的,它们将创建一个Mayavi窗口,并需要花费一点时间才能完成。由于一些版本原因,有一些会加载失败。

帮助

我们一直在想办法壮大这个项目。如果您想为Mayavi添加新的功能,请打开 issue tracker 提交一个新的特性请求。

提交bug修复和特性请求的流程如下:

  1. 从guthub上Fork该Repo
  2. 如果您添加了功能或者修复了bug,请务必添加一个测试!
  3. Push您自己的fork部分,然后向主干发送一个合并请求。

主干部分是100%稳定的(应该是)。合并请求将会在 Travis 和 Appveyor全部通过之后完成。

请注意,我们的目的是改进mayavi的整体测试,因此测试也非常重要。

开发版本快速开始

如果您想帮助改善Mayavi,您需要安装开发版,请参考`installing_git`。您可以修改您的本地Mayavi安装以便于添加新的功能(你需要在完成修改之后确保测试能通过)。当你完成之后,您可以提交一个合并请求以便您的改进出现在下一个稳定发行版中。

改进文档

一个项目的文档也非常重要。它同样需要时间来编辑和改善。在文档方面,您也可以帮助我们。

您可以在`docs/sources/mayavi`中找到文档。文档采用了sphinx,因此编辑.rst文件进行修改或者扩充都非常方便。当您完成了修改请运行:

python setup.py build_docs

in the base directory of your checkout. You will need sphinx installed for that. The documentation is then built as an HTML documentation that you can find in the sub directory build/docs/html/mayavi. Once you are comfortable with the modifications, just generate a github pull request to integrate your changes into the next stable release.

文档翻译

新加入的贡献者若想翻译文档,推荐进入Transifex加入翻译团队。

这里是一些mayavi需要翻译的(主干)文档页面。

  1. 登陆transifex
  2. 跳转到Mayavi翻译页面
  3. 点击`Request language`并填写表格。 译者:中文区已经请求过了,水平有限,很多地方的翻译有问题,请大家进行提出宝贵意见。
  4. 等待transifex上mayavi文档翻译的维护者确认。
  5. (确认之后)您可以在transifex贡献您的翻译了。
  6. 您可以在Read The Docs看到翻译的文档结果。