Projekt MDAnalysis

Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.

Podsumowanie projektu

Organizacja open source:
MDAnalysis
Pisarz techniczny:
lilyminium
Nazwa projektu:
Przewodnik użytkownika uporządkowany według tematu
Długość projektu:
Długotrwałe (5 miesięcy)

Opis projektu

Przewodnik po bibliotece MDAnalysis, oddzielny od dokumentacji interfejsu API, który zawiera:

  1. Szczegółowy przewodnik po strukturach danych używanych w metodzie MDAnalysis. Na tej stronie znajdziesz informacje o klasach Atom, AtomGroup i Universe, opcje wejścia/wyjścia oraz informacje o modyfikowaniu atomów i łączeniu grup atomów.

  2. Strona dotycząca elementów składowych analizy. Funkcje klasy AnalysisBase, AnalysisFromFunction i Analysis_class stanowią podstawę każdej analizy zdefiniowanej przez użytkownika. Warto wiedzieć, co każda klasa robi pod spodem, np. czy jest analogiczna do numpy.vectorize.

  3. Strona dotycząca wybierania grup atomów za pomocą funkcji Universe.select_atoms. Zarówno szczegóły techniczne, jak i wiedza na temat dynamiki molekularnej, która leży u podłoża tego rozwiązania.

  4. Strona o topologiach. Użytkownicy powinni znać strukturę danych, wykorzystanie, możliwości manipulacji i strukturę danych do tworzenia systemów.

  5. Strona z dostępnymi metodami wizualizacji, zarówno dla trajektorii, jak i dla bieżących analiz, które zwracają dane do wizualizacji.