Proyecto MDAnalysis

Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.

Resumen del proyecto

Organización de código abierto:
MDAnalysis
Redactor técnico:
lilyminium
Nombre del proyecto:
Una guía del usuario estructurada por tema
Duración del proyecto:
Larga duración (5 meses)

Project description

Una guía de la biblioteca de MDAnalysis, independiente de la referencia de la API, que incluye lo siguiente:

  1. Una guía detallada de las estructuras de datos que se usan en MDAnalysis. En esta página, se presentarán las clases Atom, AtomGroup y Universe, se incluirán opciones de E/S y se incluirá información para manipular átomos y combinar AtomGroups.

  2. Una página sobre los componentes básicos de Analytics. La clase AnalysisBase, la clase AnalysisFromFunction y las funciones analysis_class forman la base de cualquier análisis definido por el usuario. Vale la pena conocer lo que hace cada clase de forma interna; p.ej., si es análoga a numpy.vectorize.

  3. Página sobre la selección de grupos de átomos con Universe.select_atoms. Tanto los detalles técnicos como el conocimiento de la dinámica molecular detrás de la forma en que se implementa.

  4. Una página sobre topologías. Los usuarios deben comprender la estructura de datos, el uso, la manipulación y el framework para la creación de sistemas.

  5. Una página sobre los métodos de visualización disponibles, tanto para la trayectoria como para los análisis actuales que muestran datos para la visualización.