На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- МДА-анализ
- Технический писатель:
- лилиминиум
- Название проекта:
- Руководство пользователя, структурированное по темам.
- Длина проекта:
- Длительный ход (5 месяцев)
Описание проекта
Руководство по библиотеке MDAnaанализ, отдельное от справочника по API, которое включает в себя:
Подробное руководство по структурам данных, используемым в MDAnaанализе. На этой странице будут представлены классы Atom, AtomGroup и Universe; включить параметры ввода-вывода; и содержат информацию об управлении атомами и объединении групп атомов.
Страница со стандартными блоками анализа. Класс AnalysisBase, класс AnalysisFromFunction и функции Analysis_class составляют основу любого определяемого пользователем анализа. Стоит знать, что каждый класс делает «под капотом», например, если он аналогичен numpy.vectorize.
Страница о выборе групп атомов с помощью Universe.select_atoms. Как технические детали, так и знания молекулярной динамики лежат в основе того, как это реализовано.
Страница о топологиях. Пользователи должны понимать структуру данных, их использование, манипулирование и структуру построения систем.
Страница доступных методов визуализации, как для траектории, так и для текущего анализа, возвращающего данные для визуализации.