Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- MDAnalysis
- Rédacteur technique:
- lilyminium
- Nom du projet:
- Un guide utilisateur structuré par sujet
- Durée du projet:
- Longue durée (5 mois)
Project description
Guide de la bibliothèque MDAnalysis, distinct de la documentation de référence de l'API, qui comprend:
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 contient des informations sur la manipulation des objets Atom et la combinaison d'AtomGroups.
Une page sur les éléments de base de l'analyse. Les classes AnalysisBase, AnalysisFromFunction et les fonctions 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 est analogue à numpy.vectorize).
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 sur la façon dont cela est implémenté.
Une page sur les topologies. Les utilisateurs doivent comprendre la structure, l'utilisation, la manipulation et le framework des données pour créer des systèmes.
Page sur les méthodes de visualisation disponibles, à la fois pour la trajectoire et pour les analyses en cours qui renvoient des données à visualiser.