Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the ROG docs #406

Merged
merged 4 commits into from
Apr 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,8 @@ share/python-wheels/
*.egg
MANIFEST

# doc build files
Doc/_build/

# pycharm
.idea
9 changes: 5 additions & 4 deletions Doc/pages/H_Structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -327,10 +327,11 @@ Radius Of Gyration (ROG)
--------------------------
Index : GUI Radius Of Gyration (ROG)

**Purpose:** The Radius of Gyration is a key measure in molecular science that
calculates how compact a molecule is. It's determined by the average distance of
the molecule's atoms from its center of mass. This helps in understanding the
size and spread of molecules, especially larger ones like proteins.
**Purpose:** The Radius of Gyration can be used, for example, to
determine the compactness of a molecule. It is calculated as a root
(mass weighted) mean square distance of the atoms of a molecule relative to
its centre of mass. *ROG* can be used to follow the size and spread
of a molecule during the molecular dynamics simulation.

2. **Load Atomic Data:**
- Click on the "File" menu.
Expand Down
51 changes: 16 additions & 35 deletions Doc/pages/structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -303,48 +303,29 @@ or any molecular system subject to temporal variations.

Radius Of Gyration
''''''''''''''''''

Radius Of Gyration (*ROG*) is the name of several related measures of
the size of an object, a surface, or an ensemble of points. It is
calculated as the Root Mean Square Distance between the system and a
reference that can be either the centre of gravity of the system either
a given axis.

The *ROG* serves as a quantitative measure that characterizes the spatial distribution
and compactness of molecular or ensemble structures. ROG is instrumental in size determination,
providing precise insights into the dimensions of objects or systems. Moreover, it
plays a crucial role in shape analysis, elucidating how molecular components
are arranged concerning the center of gravity. Its ability to track
structural fluctuations over time is essential for studying dynamic processes
in molecular systems.

In *MDANSE*, the reference is chosen to be the centre of
gravity of the system under study. Mathematically, it can be defined as:

.. math::
:label: pfx134

{\mathit{ROG}{(t) = \sqrt{\frac{\sum\limits_{\alpha = 1}^{N_{\alpha}}\left( {r_{\alpha}{(t) - r_{\mathit{cms}}}(t)} \right)}{N_{\alpha}}}}}
Radius Of Gyration (*ROG*) is calculated as a root (mass weighted) mean
square distance of the components of a system relative to either its centre of
mass or a given axis of rotation. The *ROG* serves as a quantitative
measure which can be used to characterizes the spatial distribution of
a system such as a molecule or a cluster of atoms.

where :math:`N_{\alpha}`
is the number of atoms of the system, and :math:`r_{\alpha}(t)` and
:math:`r_{cms}(t)` are respectively the position of atom :math:`\alpha` and the
centre of mass of the system at time t.

*ROG* describes the overall spread of the molecule and as such is a good
measure for the molecule compactness. For example, it can be useful when
monitoring folding process.

In *MDANSE*, *ROG* is computed using the discretized version of equation
:math:numref:`pfx131`:
In MDANSE *ROG* is calculated relative to the systems centre of mass.
Mathematically, it can be defined as:

.. math::
:label: pfx135
:label: pfx134

{\mathit{ROG}{\left( {n\cdot\Delta t} \right) = \sqrt{\frac{\sum\limits_{\alpha = 1}^{N_{\alpha}}\left( {r_{\alpha}{(t) - r_{\mathit{cms}}}(t)} \right)}{N_{\alpha}}}},{n = 0}\ldots{N_{t} - 1.}}
{\mathrm{ROG}{(t) = \sqrt{\frac{\sum_{i}^{N}m_{i}\vert {\mathbf{r}_{i}{(t) - \mathbf{r}_{\mathrm{CM}}}(t)} \vert^{2}}{\sum_{i}^{N}m_{i}}}}}

where N\ :sub:`t` is the number of frames and Δt is the time step.
where :math:`N` is the number of atoms of the system,
:math:`r_{i}(t)` are the positions of the
atoms :math:`i`, :math:`r_{\mathrm{CM}}(t)` is the centre of mass of
the system and :math:`t` is the time of the simulation.

*ROG* can be used to describe the overall spread of the molecule and
as such is a good measure for the molecule compactness. For example,
it can be useful when monitoring folding process of a protein.


Solvent Accessible Surface
Expand Down
8 changes: 5 additions & 3 deletions MDANSE/Src/MDANSE/Framework/Jobs/RadiusOfGyration.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@

class RadiusOfGyration(IJob):
"""
Radius Of Gyration (ROG) is a measure of the size of an object,
a surface, or an ensemble of points. It is calculated as the Root Mean Square Distance between
the system and a reference which, in MDANSE, is the centre of gravity of the system.
The Radius of Gyration can be used, for example, to determine the
compactness of a molecule. It is calculated as a root (mass weighted)
mean square distance of the atoms of a molecule relative to its
centre of mass. ROG can be used to follow the size and spread of
a molecule during the molecular dynamics simulation.
"""

label = "Radius of Gyration"
Expand Down
Loading