その他¶

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を学習するためのチュートリアルビデオをいくつか紹介します．

SciPy2018 Mayaviチュートリアル(3時間)
- 動画: https://www.youtube.com/watch?v=r6OD07Qq2mw
- 素材: https://github.com/prabhuramachandran/mayavi-tutorial

ヘルプの表示¶

バグ報告は issue tracker に提出してください．問題を再現できるように，十分な情報を提供してください．その他のご要望については，このマニュアル，Mayaviのウェブページ，wikiページ，スタックオーバーフロー，Google検索が役に立たない場合は， issue tracker にお気軽にお問い合わせください．

質問がある場合は， Mayavi-users mailing list で質問してください．これは一部の人が使っているもので，あまり積極的ではありません．他のメーリングリストとしては， ETS Users mailing list があります．これは，Enthought Tool Suiteを習熟した多くの人が利用できる，より一般的なリストです．

Mayaviのテスト¶

Mayaviテストスイートは，コマンドラインから mayavi2 -t を使用して簡単に実行できます．テストを実行すると，特定のシステムでMayaviが正常に動作するかどうかを確認できます．実際，システムはそれぞれ異なり，既存のさまざまなオペレーティングシステムに加えて，異なるバージョンのライブラリをインストールできます．Mayavi開発者はさまざまな設定をサポートするために最善を尽くしていますが，テストスイートを実行してエラーを報告することで，開発者を支援することができます．

nose を使用してMayaviソースディレクトリのルートから以下を実行すると，両方のパッケージのユニットテストを実行できます．

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

OK (SKIP=5)

mayaviソースディレクトリから，mayaviパッケージのみのテストを実行するには，次のようにします．

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

OK (SKIP=4)

mayaviソースディレクトリから，tvtkパッケージのみのテストを実行するには，次のようにします．

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

OK (SKIP=1)

もしあなたが利用できないカバレッジに関する "ERROR" を得たら，あなたはそれを無視しても安全です．何らかの理由でnoseがテストを実行できない場合，テストは tvtk/tests と mayavi/tests の中にあります．それぞれの test_*.py を実行することができます．あるいは，現在のディレクトリをこれらのディレクトリに変更し，そこで nosetests を実行します．

これらの単体テストに加えて，mayaviにはいくつかの統合テストもあります．これらはソース配布物の integrationtests/mayavi ディレクトリにあります．次のようにしてテストを実行できます．

$ ./run.py

これらのテストは押し付けがましく，複数のmayaviウィンドウが作成され，完了までに時間がかかります．それらのいくつかは，さまざまな理由でマシン上で失敗する可能性があります．

支援¶

私たちは常に，このプロジェクトを成長させる人を探しています．Mayaviに機能を追加する必要がある場合は， issue tracker で新しい機能要求の問題を開きます．

バグ修正または新しい機能を送信するには，次のワークフローをお勧めします．

リポジトリをgithubにフォークする．
機能を追加したりバグを修正したりする場合は，テストを追加してください．
フォークをプッシュし， masterブランチにpull requestを送信します ．

master ブランチは100%安定です(でなければなりません)．pull requestがマージされるのは， Travis と Appveyor のテストに合格した後です．

Mayaviコードベースの全体的なテストを改善することも目的としているため，テストも重要です．

開発クイックスタート¶

Mayaviを改善するには，まず開発バージョンをインストールする必要があります．その後，ローカルにインストールしたMayaviを変更して，必要な機能を追加できます(変更後もテストが実行されることを確認します．)．完了したら，githubの pull request を生成して，変更を次の安定したリリースに取り込むことができます．

ドキュメントの改善¶

プロジェクトのドキュメント化は非常に重要です．また，執筆や改善にも多くの時間がかかります．ドキュメントの作成を簡単にお手伝いいただけます．

ドキュメントのソースは docs/sources/mayavi にあります．ドキュメントは sphinx に記述されています． .rst ファイルを編集してテキストを修正または拡張するのは簡単です．変更が完了したら，次のコマンドを実行してドキュメントを作成できます．

python setup.py build_docs

チェックアウトのベースディレクトリに保存します．そのためには sphinx がインストールされている必要があります．ドキュメントはHTMLドキュメントとして作成され，サブディレクトリ build/docs/html/mayavi にあります．変更に慣れたら，githubのpull requestを生成して，変更を次の安定版リリースに統合するだけです．

ドキュメントの翻訳¶

新しいコントリビュータがmayaviリファレンスを翻訳する場合は，Transifexの翻訳チームに参加することをお勧めします．

mayavi translation page はmayavi(master)のドキュメントです．

transifex サービスにログインします．
mayavi translation page に移動します．
Request language をクリックしてフォームに入力します．
transifex mayavi翻訳管理者による承認を待ちます．
(承認後)transifexで翻訳します．
翻訳された文書は Read The Docs で見ることができます．

詳細はこちら: https://docs.transifex.com/getting-started-1/translators