Progetto MDAnalysis

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.

Riepilogo del progetto

Organizzazione open source:
MDAnalysis
Technical writer:
liliminio
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 API, che include:

  1. Una guida dettagliata alle strutture di dati utilizzate in MDAnalysis. Questa pagina introdurrà le classi Atom, AtomGroup e Universe, includerà opzioni I/O e conterrà informazioni sulla manipolazione degli Atomi e sulla combinazione di AtomGruppi.

  2. 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 background, ad esempio se è analogo a numpy.vectorize.

  3. Una pagina sulla selezione di gruppi di atomi utilizzando Universe.select_atoms. Sia i dettagli tecnici che le conoscenze sulle dinamiche molecolari alla base dell'implementazione di questo approccio.

  4. Una pagina sulle topologie. Gli utenti devono comprendere la struttura, l'utilizzo, la manipolazione e il framework dei dati per la creazione dei sistemi.

  5. Una pagina sui metodi di visualizzazione disponibili, sia per la traiettoria che per le analisi correnti, che restituiscono dati da visualizzare.