mosdef-hub/foyer

Documentation regarding input/output options

オープン

#81 opened on 2017/03/02

GitHub で見るコントリビューターガイド
 (1 件のコメント) (0 件のリアクション) (1 人の担当者)Python (79 件のフォーク)auto 404
documentationgood first issue

Repository metrics

Stars
 (144 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Current inputs can come from mbuild, parmed or openmm topologies + an xml file.

By default Forcefield.apply() yields a parmed structure but for users interested in running in OpenMM we can also easily break out earlier. This needs to be tidied up a bit and properly documented.

コントリビューターガイド

調査方針
現在のドキュメントを読み、Forcefield.apply()メソッドを追跡して入出力パスを理解し、さまざまな入力ソースと出力オプションについて明確なドキュメントを追加する場所を特定します。
技術スタック
python
領域
なし
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Python
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70