mythos.observables.area_per_lipid
=================================

.. py:module:: mythos.observables.area_per_lipid

.. autoapi-nested-parse::

   Membrane area per lipid observable.



Classes
-------

.. autoapisummary::

   mythos.observables.area_per_lipid.AreaPerLipid


Module Contents
---------------

.. py:class:: AreaPerLipid

   Observable for calculating area per lipid from a trajectory.

   This observable uses the LiPyphilic package to assign leaflets and compute
   area per lipid, so see its documentation for more details on the
   lipid_sel arguments: https://lipyphilic.readthedocs.io/en/latest/.

   :param topology: MDAnalysis Universe topology for the system, should not
                    contain the trajectory data.
   :param lipid_sel: selection string for lipid tail atoms using MDAnalysis query
                     (e.g. "name GL1 GL2").


   .. py:attribute:: topology
      :type:  MDAnalysis.Universe


   .. py:attribute:: lipid_sel
      :type:  str


   .. py:method:: __call__(trajectory: mythos.simulators.io.SimulatorTrajectory) -> float