Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.
Riepilogo del progetto
- Organizzazione open source:
- MDAnalysis
- Technical writer:
- giglio
- Nome progetto:
- Una guida dell'utente strutturata per argomento
- Durata del progetto:
- Lunga esecuzione (5 mesi)
Project description
Una guida alla libreria MDAnalysis, separata dal riferimento dell'API, che include:
Una guida dettagliata alle strutture di dati utilizzate in MDAnalysis. Questa pagina introduce le classi Atom, AtomGroup e Universe, include le opzioni I/O e contiene informazioni sulla manipolazione degli Atom e sulla combinazione di AtomGroups.
Una pagina sui componenti di base di Analisi. La classe AnalysisBase, la classe AnalysisFromFunction e le funzioni analysis_class costituiscono la base di qualsiasi analisi definita dall'utente. Vale la pena sapere che cosa fa ogni classe in dettaglio, ad esempio se è analogo a numpy.vectorize.
Una pagina sulla selezione dei gruppi di atomi utilizzando Universe.select_atoms. Sia i dettagli tecnici che le conoscenze sulla dinamica molecolare alla base del modo in cui questo processo viene implementato.
Una pagina sulle topologie. Gli utenti devono comprendere la struttura, l'utilizzo, la manipolazione e il framework dei dati per la creazione dei sistemi.
Una pagina sui metodi di visualizzazione disponibili, sia per la traiettoria sia per le analisi attuali che restituiscono dati per la visualizzazione.