Evolife documentation

     summary     

    

******************************************************************************************
Module Evolife.Scenarii.Parameters:        
==================================
EVOLIFE: Global constants and parameters
******************************************************************************************


    --------------------------------------------------------------------------------------
    Function Num:        
    ============
    interpreting numerical values
    --------------------------------------------------------------------------------------
    Arguments:
        . x


    --------------------------------------------------------------------------------------
    Function Alph:        
    =============
    interpreting strings as possible python expressions
    --------------------------------------------------------------------------------------
    Arguments:
        . x


    --------------------------------------------------------------------------------------
    Function AlphNum:        
    ================
    interpreting values
    --------------------------------------------------------------------------------------
    Arguments:
        . x


    **************************************************************************************
    Class Parameters:        inherits from builtins.dict
    ================
    class Parameters: includes all modifiable parameters
    **************************************************************************************

        ----------------------------------------------------------------------------------
        Method Parameters.__init__        
        ----------------------------------------------------------------------------------
        Arguments:
            . CfgFile
            . ParamDict


        ----------------------------------------------------------------------------------
        Method Parameters.txt_to_cfg:        
        ============================
        retrieves a configuration from a text file
        ----------------------------------------------------------------------------------
        Arguments:
            . CfgTxtFile


        ----------------------------------------------------------------------------------
        Method Parameters.cfg_to_txt:        
        ============================
        stores parameters into a text file
        ----------------------------------------------------------------------------------
        Arguments:
            . CfgTxtFile


        ----------------------------------------------------------------------------------
        Method Parameters.Parameter        
        ----------------------------------------------------------------------------------
        Arguments:
            . ParamName
            . Silent
            . Default


        ----------------------------------------------------------------------------------
        Method Parameters.Param        
        ----------------------------------------------------------------------------------
        Arguments:
            . ParamName
            . default


        ----------------------------------------------------------------------------------
        Method Parameters.addParameter:        
        ==============================
        Adds a new parameter
        ----------------------------------------------------------------------------------
        Arguments:
            . Param
            . Value


        ----------------------------------------------------------------------------------
        Method Parameters.ParamNames        
        ----------------------------------------------------------------------------------


        ----------------------------------------------------------------------------------
        Method Parameters.RelevantParamNames        
        ----------------------------------------------------------------------------------


        ----------------------------------------------------------------------------------
        Method Parameters.ParamValues        
        ----------------------------------------------------------------------------------


        ----------------------------------------------------------------------------------
        Method Parameters.Relevant        
        ----------------------------------------------------------------------------------
        Arguments:
            . ParamName


    

    

    Back to Evolife