README.md

Matlantis Contrib

このリポジトリはMatlantisを使う際に役に立つ便利なexampleを募集するcontribです. Matlantisのユーザーが作成したexampleを持ち寄ることで, より快適にMatlantisが利用可能となることを目指しています.

Contributing

このcontribへexampleを追加したい場合はcontributingガイドラインに従ってPull Requestを作成してください.

どのようなexampleを募集するか

Matlantisの活用を加速するexampleとして例えば次のようなものが考えられます.

• 対象の原子系をわかりやすく可視化する
• Matlantisに実装されているfeatureの実行結果の集約, 分析を行う
• Matlantisに実装されているfeatureへの入力例を作る

上記のような内容のexampleの追加を歓迎します. また, これらはあくまでも一例であり, この他の内容についても便利なexampleを作ることができたら是非このcontribへの追加をお願いします.

How to use examples

募集したexampleはmatlantis_contrib_examplesに追加されていき, matlantis_contrib_examples内の各ディレクトリが1つのexampleに対応しています. 各exampleのディレクトリ構造は次のようになっています.

matlantis_contrib_examples
└── a_great_example(directory)
    ├── a_great_example.ipynb
    ├── input(directory)
    |   ├── hoge.xyz
    |   └── fuga.xyz
    └── output(directory)
        └── piyo.xyz

• a_great_exampleというexampleを実行するにはa_great_exampleというディレクトリをzipファイルに圧縮してMatlantisにアップロードし, ファイルツリーのペインで右クリックからExtract Archiveで解凍し、a_great_example.ipynbを実行します.
• exampleに入力ファイルが必要な場合はa_great_example/inputに入力ファイルを置いてください.
• exampleが実行結果をファイルを出力する場合は a_great_example/outputに結果が出力されます.

注意事項

• このcontribで提供するexampleの動作保証はいたしません。Matlantisの更新にともない動作しなくなる可能性があります。
• 今後、このcontribの内容を予告なく修正・削除することがあります。