htmd.home module

htmd.home.home(dataDir=None, libDir=False, shareDir=False)

Return the pathname of the HTMD root directory (or a data subdirectory).

Parameters
  • dataDir (str) – If not None, return the path to a specific data directory

  • libDir (bool) – If True, return path to the lib directory

Returns

dir – The directory

Return type

str

Example

>>> from htmd.home import home
>>> home()                                 
'.../htmd'
>>> home(dataDir="dhfr")                   
'.../data/dhfr'
>>> os.path.join(home(dataDir="dhfr"),"dhfr.pdb")  
'.../data/dhfr/dhfr.pdb'