Package Bio :: Package PopGen :: Package SimCoal :: Module Cache :: Class SimCoalCache
[hide private]
[frames] | no frames]

Class SimCoalCache

source code

Known Subclasses:

Instance Methods [hide private]
 
__init__(self, data_dir, simcoal_dir)
Initializes the cache.
source code
 
run_simcoal(self, par_file, num_sims, ploydi='1', parDir=None) source code
 
listSimulations(self, ploidy='1')
Lists available simulations.
source code
 
getSimulation(self, sim_name, ploidy='1', parDir=None)
Makes available a cached simulation.
source code
Method Details [hide private]

__init__(self, data_dir, simcoal_dir)
(Constructor)

source code 
Initializes the cache.

data_dir - Where the cache can be found
simcoal_dir - where the binaries are

IMPORTANT: The cache only makes sense if the file name univocally
identifies the model.
  For now use use the model name as key,
  and it will probably stay like that.

getSimulation(self, sim_name, ploidy='1', parDir=None)

source code 

Makes available a cached simulation.

@param sim_name simulation name.

This mainly means untaring a file.