פרויקט MD Analysis

בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.

סיכום הפרויקט

ארגון קוד פתוח:
MDAnalysis
כותבים טכניים:
lilyminium
שם הפרויקט:
מדריך למשתמש שמאורגן לפי נושא
אורך הפרויקט:
ריצה ארוכה (5 חודשים)

תיאור הפרויקט

מדריך לספריית MDAnalysis, נפרד מהמדריך ל-API, שכולל:

  1. מדריך מפורט לגבי מבני הנתונים שבהם נעשה שימוש ב-MDAnalysis. הדף הזה יציג את המחלקות Atom, AtomGroup ו-Universe; כולל אפשרויות קלט/פלט (I/O) ומכיל מידע על טיפול ב-Atom ושילוב של קבוצות Atom.

  2. דף בנושא אבני הבניין של Analytics. המחלקה AnalysisBase, מחלקה AnalysisFromFunction ו-analytics_class מהווים את הבסיס לכל ניתוח בהגדרת המשתמש. כדאי לדעת מה כל כיתה עושה מתחת לפני השטח, למשל אם היא דומה ל-numpy.vectorize.

  3. דף בנושא בחירת קבוצות של אטומים באמצעות Universe.select_atoms. גם את הפרטים הטכניים וגם את הידע בנושא דינמיקה מולקולרית שמאחורי האופן שבו ההטמעה מתבצעת.

  4. דף בטופולוגיות. המשתמשים צריכים להבין את מבנה הנתונים, את השימוש בהם, את האופן שבו אפשר לשנות אותם ואת המסגרת ליצירת מערכות.

  5. דף עם שיטות זמינות להצגה חזותית, גם של המסלול וגם של הניתוחים הנוכחיים שמחזירים נתונים להצגה חזותית.