Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- MDAnalysis
- Technischer Redakteur:
- lilyminium
- Projektname:
- Ein nach Themen strukturierter Leitfaden
- Projektlänge:
- Lang andauernd (5 Monate)
Projektbeschreibung
Ein Leitfaden zur MDAnalysis-Bibliothek, der unabhängig von der API-Referenz ist und Folgendes enthält:
Eine detaillierte Anleitung zu den in MDAnalysis verwendeten Datenstrukturen. Auf dieser Seite werden die Klassen „Atom“, „AtomGroup“ und „Universe“ vorgestellt. Außerdem finden Sie Informationen zu I/O-Optionen und zur Manipulation von Atomen und zum Kombinieren von Atomgruppen.
Eine Seite zu den Analysebausteinen. Die Klassen „AnalysisBase“, „AnalysisFromFunction“ und die Funktionen „analysis_class“ bilden die Grundlage jeder benutzerdefinierten Analyse. Es ist hilfreich zu wissen, was jede Klasse im Hintergrund tut, z.B. ob sie analog zu numpy.vectorize ist.
Eine Seite zum Auswählen von Atomgruppen mit Universe.select_atoms. Sowohl die technischen Details als auch die Kenntnisse der molekularen Dynamik, die hinter der Implementierung stehen.
Eine Seite zu Topologien. Nutzer sollten die Datenstruktur, die Verwendung, die Manipulation und das Framework zum Erstellen von Systemen verstehen.
Eine Seite mit verfügbaren Visualisierungsmethoden, sowohl für die Flugbahn als auch für aktuelle Analysen, die Daten für die Visualisierung zurückgeben.