Skip to content

Commit

Permalink
Added documentation regarding simulation leg ordering. [ref #193]
Browse files Browse the repository at this point in the history
  • Loading branch information
lohedges committed Apr 29, 2021
1 parent 204fd01 commit d95cb7f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions python/BioSimSpace/FreeEnergy/_free_energy.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,11 @@ def getData(cls, name="data", file_link=False, work_dir=None):
def analyse(work_dir, simulation_type=None):
"""Analyse existing free-energy data from a simulation working directory.
For the return values, leg0 refers to the simulation leg with the
larger number of molecules, i.e. the "bound" leg for a "binding"
free-energy simulation, or the "free" leg for a "solvation"
free-energy simulation.
Parameters
----------
Expand Down Expand Up @@ -872,6 +877,11 @@ def _update_run_args(self, args):
def analyse(work_dir, simulation_type=None):
"""Analyse existing free-energy data from a simulation working directory.
For the return values, leg0 refers to the simulation leg with the
larger number of molecules, i.e. the "bound" leg for a "binding"
free-energy simulation, or the "free" leg for a "solvation"
free-energy simulation.
Parameters
----------
Expand Down

0 comments on commit d95cb7f

Please sign in to comment.