Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- MDAnalysis
- Technischer Redakteur:
- Lilyminium
- Projektname:
- Ein nach Themen geordnetes Nutzerhandbuch
- Projektdauer:
- Langfristig (5 Monate)
Projektbeschreibung
Ein von der API-Referenz getrennter Leitfaden zur MDAnalysis-Bibliothek, der Folgendes umfasst:
Eine detaillierte Anleitung zu den in MDAnalysis verwendeten Datenstrukturen. Auf dieser Seite werden die Klassen Atom, AtomGroup und Universe, E/A-Optionen und Informationen zur Bearbeitung von Atoms und zur Kombination von AtomGroups vorgestellt.
Seite zu den Analysebausteinen Die Funktionen "AnalysisBase", "AnalyseFromFunction" und "analysis_class" bilden die Grundlage jeder benutzerdefinierten Analyse. Es lohnt sich, zu wissen, was jede Klasse im Hintergrund tut, z.B. ob es analog zu numpy.vectorize ist.
Eine Seite zum Auswählen von Atomengruppen mithilfe von Universe.select_atoms. Es gibt sowohl die technischen Details als auch das Wissen über molekulare Dynamik hinter der Umsetzung.
Eine Seite zu Topologien. Nutzende sollten die Datenstruktur, die Nutzung, die Manipulation und das Framework für den Aufbau von Systemen verstehen.
Eine Seite zu verfügbaren Visualisierungsmethoden, sowohl für die Flugbahn als auch für aktuelle Analysen, die Daten zur Visualisierung zurückgeben.