mosdef-hub/foyer

Documentation regarding input/output options

Ouverte

#81 ouverte le 2 mars 2017

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (1 personne assignée)Python (79 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (144 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Lisez la documentation actuelle, tracez la méthode Forcefield.apply() pour comprendre les chemins d'entrée/sortie et identifiez où ajouter une documentation claire pour les différentes sources d'entrée et options de sortie.
Stack technique
python
Domaine
Aucun
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70