Package firetools :: Module Study :: Class CreateStudy
[hide private]
[frames] | no frames]

Class CreateStudy

source code

Object Representing the whole study. 
    
The study object is the central component of all subsequent 
analysis. It is the first argument passed to nearly every other high 
level function in the toolset. In reality its just a central 
placeholder to connect and store parameters and results from various 
other functions.
    
    Inputs
            workingdir              path to study directory to be created
            title                   title
    
    Procedure
            Create / Overwrite main study directory
            Name empty lists for source and output data series
            
    Data
            sourcenames             list of source data names
            infodict                dict of source data parameters 
            serieslist              list of output data series names
            seriesdict              dict of extract var {name:file}
            
    

Instance Methods [hide private]
 
__init__(self, workingdir="", title="")
Initialize the study object.
source code
 
Save(self)
Save the study object to mainpickle
source code
 
UpdateDates(self, newdates)
Add some new unique dates to the study dates
source code
 
AddSeries(self, vardict)
Add an Output Data Dict and update namelist
source code
 
AddSource(self, varname, vardict)
Add a Source Data Dictionary and update namelist
source code
Method Details [hide private]

__init__(self, workingdir="", title="")
(Constructor)

source code 

Initialize the study object. Set the parameters, make output folders, and create new empty lists to store data