mosdef-hub/foyer

Documentation regarding input/output options

Offen

#81 geöffnet am 02.03.2017

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (1 zugewiesene Person)Python (79 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (144 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Lesen Sie die aktuelle Dokumentation, verfolgen Sie die Forcefield.apply() Methode, um die Ein /Ausgabepfade zu verstehen, und identifizieren Sie, wo eine klare Dokumentation für die verschiedenen Eingabequellen und Ausgabeoptionen hinzugefügt werden sollte.
Tech Stack
python
Domain
Keine
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70