Projet MDAnalysis

Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.

Résumé du projet

Organisation Open Source:
MDAnalysis
Rédacteur technique:
lilyminium
Nom du projet:
Guide de l'utilisateur structuré par sujet
Durée du projet:
Exécution de longue durée (5 mois)

Project description

Guide de la bibliothèque MDAnalysis, distinct de la documentation de référence de l'API, comprenant les éléments suivants:

  1. Guide détaillé des structures de données utilisées dans MDAnalysis. Cette page présente les classes Atom, AtomGroup et Universe, inclut des options d'E/S, et fournit des informations sur la manipulation et la combinaison d'AtomGroups.

  2. Page des éléments de base Analyse Les classes AnalysisBase, AnalysisFromFunction et analysis_class constituent la base de toute analyse définie par l'utilisateur. Il est utile de savoir ce que chaque classe fait sous le capot, par exemple, si elle est semblable à numpy.vectorize.

  3. Page sur la sélection de groupes d'atomes à l'aide de Universe.select_atoms. Les détails techniques et les connaissances en dynamique moléculaire qui sous-tendent la mise en œuvre de cette approche.

  4. Page sur les topologies Les utilisateurs doivent comprendre la structure, l'utilisation, la manipulation et le cadre des données pour la construction de systèmes.

  5. Une page sur les méthodes de visualisation disponibles, à la fois pour la trajectoire et pour les analyses en cours qui renvoient des données pour la visualisation.