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:
Un guide de l'utilisateur structuré par thème
Durée du projet:
Exécution longue (5 mois)

Project description

Un guide de la bibliothèque MDAnalysis, distinct de la documentation de référence de l'API, comprenant:

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

  2. Page sur les é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 en arrière-plan (par exemple, si elle ressemble à 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 matière de dynamique moléculaire sous-jacentes à la mise en œuvre.

  4. Page sur les topologies. Les utilisateurs doivent comprendre la structure, l'utilisation, la manipulation et le cadre des données pour la création 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 à des fins de visualisation.