Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- MDAnalysis
- Technical Writer:
- lilyminium
- Nome del progetto:
- Una guida dell'utente strutturata per argomento
- Durata del progetto:
- A lungo termine (5 mesi)
Project description
Una guida alla libreria MDAnalysis, separata dal riferimento all'API, che include:
Una guida dettagliata alle strutture di dati utilizzate in MDAnalysis. Questa pagina illustra le classi Atom, AtomGroup e Universe, include le opzioni di I/O e contiene informazioni sulla manipolazione degli atomi e sulla combinazione di AtomGroup.
Una pagina sui componenti di base di Dati. La classe AnalysisBase, la classe AnalysisFromFunction e le funzioni analysis_class formano la base di qualsiasi analisi definita dall'utente. È interessante sapere che cosa fa ogni classe dietro le quinte, ad esempio se è analogo a numpy.vectorize.
Una pagina sulla selezione di gruppi di atomi utilizzando Universe.select_atoms. Sia i dettagli tecnici che le conoscenze di dinamica molecolare alla base del modo in cui viene implementata.
Una pagina sulle topologie. Gli utenti devono comprendere la struttura, l'utilizzo, la manipolazione e il framework dei dati per la creazione di sistemi.
Una pagina sui metodi di visualizzazione disponibili, sia per la traiettoria che per le analisi correnti che restituiscono dati per la visualizzazione.